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.
Scopes
payments:read
Path Parameters
paymentId
string<uuid>
required
Identifier of the resource in Payrails.
Query Parameters
includeInstrument
boolean
default:false
Boolean indicating if the payment instrument should be included in the response.
includePaymentToken
boolean
default:false
Boolean indicating if the instrument payment token should be included in the response.
includeProviderAccountDisplayName
boolean
default:false
Boolean indicating if the provider account display name should be included in the response.
includeHolderReference
boolean
default:false
Boolean indicating if the holder reference should be included in the response.
Response
Payment entity found, and all details are included.
id
string<uuid>
required
Unique identifier of the Payment in Payrails.
status
enum<string>
required
Current status of the Payment in Payrails. More information can be found here.
Available options:
Created,
Pending,
Unknown,
Failed,
Expired,
Preauthorized,
Authorized,
Canceled,
Captured,
Refunded
createdAt
string<date-time>
Exact date and time when the Payment was created in Payrails. Possibly differs slightly from the date in the PSP.
providerId
string<uuid>
Unique identifier of the Provider that was used to process the Payment.
paymentMethodType
string
Type of payment method used to process the payment.
providerIntegrationType
string
Type of integration used to process the payment (in case the payment provider supports multiple).
providerName
string
Name of the Provider that was used to process the Payment, e.g. Adyen, Checkout, Stripe.
providerReference
string
Unique identifier of the Payment in an external system, e.g. PSP.
providerConfigId
string<uuid>
Unique identifier of the merchant-specific Provider Configuration that was used to process the Payment. This can include the set of credentials used, the merchant account, country, vertical, etc.
holderId
string<uuid>
Unique identifier of the Holder that is involved in the Payment.
amount
object
Amount of the Payment.
Hide child attributes
amount.value
string
required
Decimal amount of the major currency unit. Can be any precision.
Pattern: [0-9]+(\.[0-9]+)?
Example:
"12.50"
amount.currency
string
required
ISO 3-letter currency code.
Pattern: ^[A-Z]{3}$
Example:
"EUR"
instrumentId
string<uuid>
Unique identifier of the Instrument that was used for the Payment in Payrails.
instrumentTokenId
string<uuid>
Unique identifier of the specific Token inside the Instrument used for the Payment in Payrails.
instrument
object
Optionally included details about the instrument used for the payment.
Hide child attributes
instrument.id
string<uuid>
required
Id of the instrument.
instrument.createdAt
string<date-time>
required
Date and time when the Instrument was created in Payrails.
instrument.updatedAt
string<date-time>
required
When the Instrument was last updated.
instrument.holderId
string<uuid>
required
Unique identifier of the Holder in Payrails.
instrument.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,
sbp,
wero
instrument.status
enum<string>
required
Status of the instrument.
Available options:
created,
deleted,
enabled,
disabled,
transient
instrument.displayName
string
Instrument name suitable for display.
instrument.description
string
Description of the instrument.
instrument.default
boolean | null
True if this instrument is set as default for the holder.
instrument.merchantReference
string
Merchant-provided reference for the instrument.
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.
instrument.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
instrument.networkTransactionReference
string
Identifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.
instrument.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.
instrument.data
Card · object
Type-specific information about the instrument.
Card
BankAccount
PayPal
GooglePay
ApplePay
DCB
MBWayDirect
Hide child attributes
instrument.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
instrument.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"
instrument.data.suffix
string
required
Last digits of the Card number.
Required string length: 4
instrument.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
instrument.data.binLookup
object
Information about an issuer by the given BIN (or IIN).
Hide child attributes
instrument.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"
instrument.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
instrument.data.binLookup.localNetwork
enum<string>
Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.
Available options:
bancontact,
cartesbancaires,
dankort,
mada
instrument.data.binLookup.issuer
string
Name of the bank or institution that issued the card.
instrument.data.binLookup.issuerCountry
object
Country of the bank or institution that issued the card.
Hide child attributes
instrument.data.binLookup.issuerCountry.code
string
required
ISO 3166-1 alpha-2 country code.
Pattern: ^[A-Z]{2}$
instrument.data.binLookup.issuerCountry.iso3
string
ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
Pattern: ^[A-Z]{3}$
instrument.data.binLookup.issuerCountry.name
string
The English name of the country. Returned by Payrails, but not interpreted in requests.
instrument.data.binLookup.segment
string
Segment of the card, e.g. gold, black, business.
instrument.data.binLookup.type
string
Type of the card, e.g. credit, debit, prepaid, gift.
instrument.data.binLookup.typeDetails
string
More information about the card type, e.g. personal, commercial.
instrument.data.binLookup.isNetworkToken
boolean
Indicates whether the card credential represents a network token rather than a primary account number (PAN).
instrument.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.
instrument.data.billingAddress
object
Billing Address of the instrument.
Hide child attributes
instrument.data.billingAddress.street
string
The name of the street of a postal address.
instrument.data.billingAddress.doorNumber
string
The number on the door, building, or room.
instrument.data.billingAddress.complement
string
Additional addressing information, 2nd line of postal address.
instrument.data.billingAddress.area
string
The name of the suburb or area within a city.
instrument.data.billingAddress.city
string
The name of the city of a postal address.
instrument.data.billingAddress.postalCode
string
The postal code.
instrument.data.billingAddress.state
string
The name of the state a postal address is in.
instrument.data.billingAddress.country
object
The country where the address is in.
Hide child attributes
instrument.data.billingAddress.country.code
string
required
ISO 3166-1 alpha-2 country code.
Pattern: ^[A-Z]{2}$
instrument.data.billingAddress.country.iso3
string
ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
Pattern: ^[A-Z]{3}$
instrument.data.billingAddress.country.name
string
The English name of the country. Returned by Payrails, but not interpreted in requests.
instrument.data.billingAddress.latitude
number<float>
Latitude of the address in the GPS coordinate system.
instrument.data.billingAddress.longitude
number<float>
Longitude of the address in the GPS coordinate system.
instrument.data.billingAddress.phone
object
The phone to contact in the address (can be different that the customer's).
Hide child attributes
instrument.data.billingAddress.phone.number
string
required
The local number of the phone, such that countryCode + number can be dialed.
Pattern: ^[0-9]+$
instrument.data.billingAddress.phone.countryCode
string
International prefix of the phone, if known separately.
Pattern: ^\+?[0-9]+$
instrument.data.billingAddress.alias
string
Name of the address, e.g. home, work.
instrument.data.billingAddress.name
string
Name of the person to whom the address belongs to.
instrument.data.billingAddress.lastName
string
Last name of the person to whom the address belongs to.
instrument.data.billingAddress.email
string
Email of the person to whom the address belongs to.
instrument.data.expiryMonth
string
Expiry month of the Card.
Required string length: 2
instrument.data.expiryYear
string
Expiry year of the Card.
Required string length: 4
instrument.data.holderName
string
Name of the owner of the Card.
instrument.data.taxId
string
Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument.
instrumentToken
object
Optionally included details about the instrument token used for the payment.
Hide child attributes
instrumentToken.id
string<uuid>
required
Id of the token in Payrails.
instrumentToken.createdAt
string<date-time>
required
Date and time when the Token was created in Payrails.
instrumentToken.updatedAt
string<date-time>
required
When the Token was last updated.
instrumentToken.instrumentId
string<uuid>
required
Id of the payment instrument the token belongs to.
instrumentToken.status
enum<string>
required
Status of the token.
Available options:
created,
enabled,
disabled,
deleted
instrumentToken.type
enum<string>
required
Type of the token.
Available options:
network,
vault,
psp,
networkOffers,
networkGateway
instrumentToken.providerId
string<uuid>
required
Id of the provider the token belongs to.
instrumentToken.reference
string
required
Unique identifier of the token in the provider's system.
instrumentToken.providerConfigId
string<uuid>
Id of the configuration in the provider the token belongs to.
instrumentToken.meta
object
Any merchant or provider-specific data that should be stored for context in the token.
transactionReference
string
Merchant-specific identifier of the execution. This can be used for searching for the Payment later.
transactionElementReference
string
Identifier of the step in the Workflow that led to this Payment.
pspRedirectUrl
string
In case a redirection process is needed during the Payment, this is the URL where the PSP requested Payrails to redirect the user to.
capturedAmount
object
Amount that was captured from the Payment. If no capture is initiated for the payment, the value will be 0 until a successful capture occurs.
Hide child attributes
capturedAmount.value
string
required
Decimal amount of the major currency unit. Can be any precision.
Pattern: [0-9]+(\.[0-9]+)?
Example:
"12.50"
capturedAmount.currency
string
required
ISO 3-letter currency code.
Pattern: ^[A-Z]{3}$
Example:
"EUR"
refundedAmount
object
Amount that was refunded from the Payment. If multiple partial refunds have been made, this will be the sum of them. If no refund is initiated for the payment, the value will remain 0 until a successful refund occurs.
Hide child attributes
refundedAmount.value
string
required
Decimal amount of the major currency unit. Can be any precision.
Pattern: [0-9]+(\.[0-9]+)?
Example:
"12.50"
refundedAmount.currency
string
required
ISO 3-letter currency code.
Pattern: ^[A-Z]{3}$
Example:
"EUR"
availableAmount
object
Amount still available to refund from the Payment, i.e. capturedAmount minus refundedAmount. Reflects partial captures, so refunds are never allowed to exceed what was actually captured.
Hide child attributes
availableAmount.value
string
required
Decimal amount of the major currency unit. Can be any precision.
Pattern: [0-9]+(\.[0-9]+)?
Example:
"12.50"
availableAmount.currency
string
required
ISO 3-letter currency code.
Pattern: ^[A-Z]{3}$
Example:
"EUR"
merchantReturnUrl
string
In case a redirection process is needed during the Payment, Payrails will return to this merchant-specific URL after it finished.
merchantReference
string
Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.
meta
object
Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our Meta Fields guide. See Meta for every field.
Hide child attributes
meta.order
object
The order being placed on your system. See Meta.order for every field.
meta.customer
object
The customer placing the order. See Meta.customer for every field.
meta.clientContext
object
Data describing the customer's device or browser. See Meta.clientContext for every field.
meta.vendor
object
Description of a vendor that provides the order.
See Meta.vendor for every field.
meta.risk
object
Configuration values for the risk prevention check. See Meta.risk for every field.
meta.subscription
object
Configuration of a subscription process. See Meta.subscription for every field.
meta.tags
object
Additional meta fields to be sent to the payment providers which support metadata / tags.
For example, sent to Stripe as metadata.
Because these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.
meta.paymentMethods
object
Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.
See Meta.paymentMethods for every field.
meta.upi
any
Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.
See Meta.upi for every field.
history
object[]
History of Payment Operations executed on the Payment.
Hide child attributes
history.id
string<uuid>
required
Unique identifier of the Payment Operation in Payrails.
history.result
enum<string>
required
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
history.createdAt
string<date-time>
Exact date and time when the Payment Operation was created in Payrails. Possibly differs slightly from the date in the PSP.
history.updatedAt
string<date-time>
Exact date and time when the Payment Operation was updated in Payrails. Possibly differs slightly from the date in the PSP.
history.paymentId
string<uuid>
Unique identifier of the Payment that this Operation belongs to in Payrails.
history.type
enum<string>
Operation Type that was executed in the Provider.
Available options:
Authorize,
Preauthorize,
Capture,
Cancel,
Refund,
Credit,
SendNotification,
CaptureNotification,
RefundNotification,
CancelNotification,
AuthorizeNotification,
ChargebackNotification,
ChargebackReverseNotification,
IssuerCommentsNotification,
AcceptDispute,
DefendDispute,
SubmitEvidence,
PullDispute,
Get,
Search,
GetToken,
Tokenize,
DisableToken,
Register,
Generate3DS,
Validate3DS,
PayerAuthInit,
PayerAuthCheckEnroll,
PayerAuthValidate,
RefundFailedNotification,
RefundReversedNotification,
CaptureFailedNotification,
ValidateRedirect,
RefundNotificationUpdated
history.reason
string
Reason why the operation was done.
history.reasonDescription
string
Free-text description that came with the reason.
history.initiator
object
Who requested the operation. Only refunds requested through the refund endpoint carry it. It is absent on all other operations, including captures, cancels, a refund made by a cancel, and refunds made before attribution was introduced.
Hide child attributes
history.initiator.type
enum<string>
required
user is a portal user, client an API client, and system a refund that no caller requested, such as one triggered by an event or the internal API.
Available options:
user,
client,
system
history.initiator.id
string
Auth user ID for user, or the OAuth client ID for client. Absent for system, and for a user who could not be identified.
history.initiator.email
string
Email of the user. Only returned with includeInitiatorEmail=true to portal users, for users that still exist.
history.initiator.internal
boolean
Whether the user is Payrails support staff. Only returned with includeInitiatorEmail=true to portal users, for users that still exist.
history.providerReference
string
Unique identifier of the Payment Operation in an external system. Some PSPs provide a specific ID for each update in the Payment, but most of them use the same as the original Payment.
history.paymentStatus
string
The payment status just after the operation done.
history.amount
object
Hide child attributes
history.amount.value
string
required
Decimal amount of the major currency unit. Can be any precision.
Pattern: [0-9]+(\.[0-9]+)?
Example:
"12.50"
history.amount.currency
string
required
ISO 3-letter currency code.
Pattern: ^[A-Z]{3}$
Example:
"EUR"
history.responseCode
string
Original response code from the PSP, which Payrails interpreted for the result field.
history.requiredActionDetails
object
In case a Provider requests an action to continue executing an Operation, this object contains the necessary information for it.
Hide child attributes
history.requiredActionDetails.redirectUrl
string
The URL that the Merchant should redirect the user to.
history.requiredActionDetails.redirectMethod
enum<string>
The HTTP method that should be used when redirecting to the redirectUrl.
Available options:
GET,
POST
history.requiredActionDetails.parameters
object
Map of parameters that are necessary for the redirection. In case the redirectMethod is GET, these parameters can be appended in the query string, but if it's POST, they should be sent via form.
Hide child attributes
history.requiredActionDetails.parameters.{key}
string
history.errorDetails
string
Error details from the provider.
history.acquirerReference
string
Acquirer Reference Number (ARN) for the Payment Operation (only Refunds and Captures), which we receive from some of the Provider.
history.workspaceId
string<uuid>
Workspace ID that the workflow configuration belongs to.
history.operationLogs
object[]
List of operation logs associated with this operation.
Hide child attributes
history.operationLogs.id
string<uuid>
Unique identifier of the Payment Operation Log in Payrails.
history.operationLogs.createdAt
string<date-time>
Exact date and time when the Payment Operation Log was created in Payrails. Possibly differs slightly from the date in the PSP.
history.operationLogs.operationId
string<uuid>
Unique identifier of the Payment Operation that this Log belongs to in Payrails.
history.operationLogs.input
string
Original request object sent to the Provider.
history.operationLogs.output
string
Original response object received from the Provider.
history.operationLogs.workspaceId
string<uuid>
Workspace ID that the workflow configuration belongs to.
history.providerLatency
string
Latency of the operation on the provider side.
history.totalLatency
string
Total latency of the operation.
providerAccountDisplayName
string
Display name of the Provider Account/Configuration that was used to process the Payment.
providerDisplayName
string
Display name of the Provider that was used to process the Payment.
workspaceId
string
Workspace ID that the Payment belongs to.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Payrails Docs","description":"Developer and operator documentation for Payrails, the payment operating system for global enterprises: payment orchestration across providers, PCI-compliant tokenization, analytics and reporting, Chargebacks, and the Payrails REST API.","colors":{"primary":"#D63D00","light":"#E4853A"},"logo":{"light":"https://mintcdn.com/payrails-42074109/knNnlxc2J__TB9tW/logo/light.svg?fit=max\u0026auto=format\u0026n=knNnlxc2J__TB9tW\u0026q=85\u0026s=2692c29175ef45b637b4e2df6e2da330","dark":"https://mintcdn.com/payrails-42074109/knNnlxc2J__TB9tW/logo/dark.svg?fit=max\u0026auto=format\u0026n=knNnlxc2J__TB9tW\u0026q=85\u0026s=651119b7fb40dda938e2f9a7a276ee1c"},"favicon":"https://mintcdn.com/payrails-42074109/zqk7oWHZbW3YniA1/favicon.png?fit=max\u0026auto=format\u0026n=zqk7oWHZbW3YniA1\u0026q=85\u0026s=70b0991c3a7ad3c2faa4530e27040cf8","api":{"params":{"expanded":"all","post":["nullable","x-internal"]},"playground":{"display":"simple"},"examples":{"defaults":"required","prefill":true,"autogenerate":true},"url":"full"},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://www.payrails.com","label":"Go to payrails.com"}],"primary":{"type":"button","label":"Book a demo","href":"https://www.payrails.com/contact"}},"footer":{"socials":{"x":"https://x.com/Payrails_com","github":"https://github.com/payrails","linkedin":"https://www.linkedin.com/company/payrails"},"links":[{"header":"Company","items":[{"label":"payrails.com","href":"https://www.payrails.com"}]}]},"seo":{"metatags":{"og:locale":"en_US","twitter:site":"@Payrails_com","msvalidate.01":"7723ABF900EAD08F0500790E9BFC62E7"},"organization":{"id":"https://www.payrails.com#organization","name":"Payrails","legalName":"Payrails GmbH","url":"https://www.payrails.com/","logo":"https://www.payrails.com/payrails-logo.svg","sameAs":["https://www.linkedin.com/company/payrails/","https://www.crunchbase.com/organization/payrails","https://www.wikidata.org/wiki/Q137211152","https://x.com/Payrails_com"]}},"styling":{"eyebrows":"breadcrumbs","latex":false},"integrations":{"cookies":{"key":"mintlify_telemetry_enabled","value":"true"}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/payrails-42074109/_AaiU-jGVknFpls9/images/common/og-thumbnail-bg-v5.png?fit=max\u0026auto=format\u0026n=_AaiU-jGVknFpls9\u0026q=85\u0026s=b08b137c9aa7638918675c41a07b33c6"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"instructions":["Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.","Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.","Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.","Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.","Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.","Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.","Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code."]},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"payrails-42074109","hasAudioNarration":false,"actualSubdomain":"payrails-42074109","customDomains":["docs.payrails.com"],"gitSource":{"type":"github","owner":"payrails","repo":"docs-payrails-com","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afdc9f4a509e646ab9e0062","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Payment Orchestration","count":249},{"language":"default","tag":"Integrations","count":236},{"language":"default","tag":"API Reference","count":192},{"language":"default","tag":"Payment methods","count":147},{"language":"default","tag":"Guides","count":129},{"language":"default","tag":"Payment providers","count":62},{"language":"default","tag":"Dispute","count":57},{"language":"default","tag":"Disputes","count":57},{"language":"default","tag":"SDKs","count":38},{"language":"default","tag":"Payment","count":28}],"searchSettings":{"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"type":"link","url":"https://www.payrails.com/contact"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[{"filePath":"css/styles.css","content":"*,:before,:after{box-sizing:border-box}:before,:after{--tw-content: \"\"}html,:host{-webkit-text-size-adjust:100%;tab-size:4;font-feature-settings:normal;font-variation-settings:normal;-webkit-tap-highlight-color:transparent;font-family:ui-sans-serif,\n system-ui,\n sans-serif,\n Apple Color Emoji,\n Segoe UI Emoji,\n Segoe UI Symbol,\n Noto Color Emoji;line-height:1.5}body{line-height:inherit;margin:0}hr{height:0;color:inherit;border-top-width:1px}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}a{color:inherit}b,strong{font-weight:bolder}code,kbd,samp,pre{font-feature-settings:normal;font-variation-settings:normal;font-family:ui-monospace,\n SFMono-Regular,\n Menlo,\n Monaco,\n Consolas,\n Liberation Mono,\n Courier New,\n monospace;font-size:1em}small{font-size:80%}sub,sup{vertical-align:baseline;font-size:75%;line-height:0;position:relative}sub{bottom:-0.25em}sup{top:-0.5em}table{text-indent:0;border-color:inherit;border-collapse:collapse}button,select{text-transform:none}:-moz-focusring{outline:auto}:-moz-ui-invalid{box-shadow:none}#page-context-menu-button{border-radius:var(--border-radius-sm) 0 0 var(--border-radius-sm)}#page-context-menu-button+button,#page-context-menu-button+*+button{border-left:none;border-radius:0 var(--border-radius-sm) var(--border-radius-sm) 0}.peer:not(.is-custom) [data-docs-theme] header+div,header#navbar>div.mx-auto{margin:0 auto;max-width:100rem}[data-active-nav-item=\"true\"]>button,[data-active-nav-item=\"true\"]>a{color:var(--accent)}#navbar>div.mx-auto div.h-16{height:calc(var(--spacing) * 13)}#navbar>div.mx-auto div.h-12{height:calc(var(--spacing) * 8)}@media (min-width: 1024px){#sidebar-content{margin-top:calc(var(--mintlify-slot-header-height, 7rem) - var(--spacing) * 21)}}#navbar>div.mx-auto button.h-9{height:calc(var(--spacing) * 8)}#topbar-cta-button a>div{height:calc(var(--spacing) * 8);padding:0 calc(var(--spacing) * 3.5);border:1px solid rgb(var(--gray-400) / 0.3);border-radius:8px;background:rgb(var(--background-light));color:rgb(var(--gray-500))}#topbar-cta-button a svg{display:none}#topbar-cta-button a:hover>div{color:rgb(var(--gray-800))}html.dark #topbar-cta-button a>div{border-color:rgb(var(--gray-600) / 0.3);background:rgb(var(--background-dark));color:rgb(var(--gray-300))}html.dark #topbar-cta-button a:hover>div{color:rgb(var(--gray-100))}#navbar.peer.is-not-custom.is-not-wide.is-not-center+div,#navbar+div .page-content{max-width:100rem;margin:0 auto}#content-container>div.max-w-5xl{max-width:70rem}.mdx-content a{color:var(--accent);text-decoration:none;\u0026:hover,\u0026:focus{color:var(--link-hover)}\u0026:active,\u0026:active:hover{color:var(--link-active)}}.mdx-content a.link:not(:has(div,img,picture)):not(.not-prose *){border-bottom:0;text-decoration-line:underline;text-decoration-thickness:max(1px, 0.0625rem);text-underline-offset:0.2em;text-decoration-skip-ink:auto;text-decoration-color:color-mix(in srgb, currentColor 70%, transparent);\u0026:hover,\u0026:focus,\u0026:has(>code){text-decoration-color:currentColor}}.callout .prose :where(h1,h2,h3,h4):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){margin-top:0}#content-area>#content{margin-bottom:calc(var(--spacing) * 8)}#content-area>:is(#content,[id^=\"api-playground\"])+div:not([id]){padding-bottom:calc(var(--spacing) * 6)}#footer.advanced-footer>div{padding-bottom:calc(var(--spacing) * 8);padding-top:calc(var(--spacing) * 8);gap:calc(var(--spacing) * 4)}#footer [data-testid=\"mode-switch-light\"],#footer [data-testid=\"mode-switch-dark\"],#footer [data-testid=\"mode-switch-system\"]{display:none}@media (min-width: 1024px){[role=\"group\"]:has(>[data-theme-preference-value]){width:fit-content;gap:2px;padding:1px}[role=\"group\"]>[data-theme-preference-value]{width:1.5rem;height:1.5rem}}html:not(.dark) #sidebar-content a.text-gray-700{color:rgb(var(--gray-700))}html:not(.dark) #sidebar-content a.text-gray-700:hover{color:rgb(var(--gray-950))}#navigation-items li>button[aria-expanded]{width:100%}#navigation-items li>button[aria-expanded]>div:first-child:has(>svg){order:1}#navigation-items li>button[aria-expanded]>div:first-child>svg{width:0.75rem}#navigation-items li>button[aria-expanded]>div:first-child>svg:not(.text-primary){color:rgb(var(--gray-500) / 0.8)}html.dark #navigation-items li>button[aria-expanded]>div:first-child>svg:not(.text-primary){color:rgb(var(--gray-400))}@media (hover: hover){#navigation-items li>button[aria-expanded]:hover>div:first-child>svg,html.dark #navigation-items li>button[aria-expanded]:hover>div:first-child>svg{color:inherit}}#navigation-items ul ul{margin-left:-0.5rem}html.dark :is(#content,#header>.prose,#table-of-contents),html.dark :is(#navbar,#sidebar-content,#content-area) .dark\\:text-gray-400,html.dark #footer a.dark\\:text-white\\/50{color:rgb(var(--gray-300))}html.dark :is(#navbar,#sidebar-content,#content-area) .dark\\:text-gray-400:hover,html.dark #footer a.dark\\:text-white\\/50:hover,html.dark #table-of-contents .toc-item:not([data-active])>a:hover{color:rgb(var(--gray-100))}html.dark #search-bar-entry{color:rgb(var(--gray-400))}html.dark #footer .dark\\:bg-gray-600{background-color:rgb(var(--gray-400))}html.dark #footer .dark\\:bg-gray-600:hover{background-color:rgb(var(--gray-200))}html.dark .sidebar-group-icon[src*=\"/images/icons/nav/\"]{filter:invert(0.9)}html:not(.dark) .nav-tag-pill-text{color:var(--button-primary-bg-active)}html:not(.dark) .text-green-700.bg-green-400\\/20{color:#166534}html:not(.dark) .text-yellow-700.bg-yellow-400\\/20{color:#854d0e}html:not(.dark) .text-orange-700.bg-orange-400\\/20{color:#9a3412}.text-\\[\\#FFFFFF\\].bg-\\[\\#2AB673\\]{background-color:#15803d}.text-\\[\\#FFFFFF\\].bg-\\[\\#C28C30\\]{background-color:#a16207}.text-\\[\\#FFFFFF\\].bg-\\[\\#DA622B\\]{background-color:#c2410c}html:not(.dark) [data-component-part=\"field-required-pill\"]{color:#b91c1c}html:not(.dark) [data-component-part=\"code-group-tab-bar\"] .text-gray-500:not(:hover){color:rgb(var(--gray-600))}html:not(.dark) [data-component-part=\"code-group-tab-bar\"] .text-primary{color:var(--button-primary-bg-hover)}html:not(.dark) [data-component-part=\"field-info-pill\"] .text-stone-400{color:rgb(var(--gray-600))}html.dark [data-component-part=\"field-info-pill\"] .dark\\:text-stone-500{color:rgb(var(--gray-400))}html.dark :is(#navbar a.dark\\:text-gray-200,#content-area a.dark\\:text-gray-50){color:rgb(var(--gray-50))}html.dark #content-area a.dark\\:text-gray-50:hover{color:var(--accent)}html.dark #content-area a.dark\\:text-gray-50>svg{color:rgb(var(--gray-400))}#table-of-contents .toc-item[data-active]>a{color:var(--accent)}@layer theme{.peer.is-custom~#footer.advanced-footer{display:flex!important;margin-top:auto!important}div:has(>.peer.is-custom~#footer.advanced-footer){display:flex!important;flex-direction:column;min-height:100vh}}#sidebar-content img[src^=\"https://assets.payrails.io/img/logos/\"],#sidebar-content img[src*=\"/images/icons/letters/\"],#sidebar-content img[src*=\"/images/icons/nav/\"]:not(.sidebar-group-icon){width:1.5rem;height:1.5rem;--tile-radius: 0.375rem;border-radius:var(--tile-radius)}#sidebar-content img[src*=\"/images/icons/nav/\"]:not(.sidebar-group-icon){padding:3px;background:var(--tag-neutral-bg)}#sidebar-content img[src^=\"https://assets.payrails.io/img/logos/\"],#sidebar-content img[src*=\"/images/icons/letters/\"],.prose img.page-logo,.provider-card-logo,.payment-method-logo{--tile: var(--tag-neutral-bg);--r: calc(var(--tile-radius) - 1px);background:radial-gradient(circle at 100% 100%, var(--tile) calc(var(--r) - 0.5px), transparent var(--r)) 1px 1px / var(--r) var(--r) no-repeat,\n radial-gradient(circle at 0 100%, var(--tile) calc(var(--r) - 0.5px), transparent var(--r)) calc(100% - 1px) 1px / var(--r) var(--r) no-repeat,\n radial-gradient(circle at 100% 0, var(--tile) calc(var(--r) - 0.5px), transparent var(--r)) 1px calc(100% - 1px) / var(--r) var(--r) no-repeat,\n radial-gradient(circle at 0 0, var(--tile) calc(var(--r) - 0.5px), transparent var(--r)) calc(100% - 1px) calc(100% - 1px) / var(--r) var(--r) no-repeat,\n linear-gradient(var(--tile), var(--tile)) center / calc(100% - 2px) calc(100% - 2 * var(--r)) no-repeat,\n linear-gradient(var(--tile), var(--tile)) center / calc(100% - 2 * var(--r)) calc(100% - 2px) no-repeat}@media (max-width: 767px){.expandable-content{margin:0!important;padding-left:6px!important;padding-right:0!important}.expandable-content .expandable{border-right:0;border-top-right-radius:0;border-bottom-right-radius:0}.expandable-content .expandable-content{min-width:16rem}.expandable-content:not(.expandable-content *){overflow-x:auto}.expandable-content .prose{padding-right:12px}.param-head div{min-width:0}[data-component-part=\"field-info-pill\"]{display:inline-block!important;max-width:100%;vertical-align:bottom}[data-component-part=\"field-info-pill\"]>span{display:-webkit-box;-webkit-box-orient:vertical;-webkit-line-clamp:2;line-clamp:2;overflow:hidden}}.page-logos{display:flex;gap:0.75rem;margin:-1rem 0 1.75rem}.prose .page-logos picture{margin:0}.prose img.page-logo{display:block;width:3.5rem;height:3.5rem;margin:0;--tile-radius: 0.75rem;border-radius:var(--tile-radius);object-fit:contain}@media (prefers-reduced-motion: no-preference){html{scroll-behavior:smooth}}"},{"filePath":"css/vars.css","content":":root{--pr-orange: #d63d00;--pr-black: #000;--pr-white: #fff;--pr-heritage: #0a6cff;--pr-antalya-sea: #597991;--pr-dublin-ale: #e4853a;--pr-baku-brass: #8a725c;--pr-cairo-sand: #d6cbc1;--accent: rgb(var(--primary));--link-active: var(--button-primary-bg-active);--link-hover: var(--button-primary-bg-hover);--main-color: var(--pr-orange);--background: var(--pr-white);--badge-new-bg: #ffedd5;--badge-new-text: #ad3100;--bento-media-gradient-end: #100;--bento-media-gradient-start: #f34f12;--border-radius-sm: 4px;--border-hover: #d1d1d1;--border-subtle: #e5e5e5;--button-focus-outline: #09090b;--button-ghost-bg-active: #e4e4e7;--button-ghost-bg-hover: #f4f4f5;--button-ghost-text: #18181b;--button-primary-bg: var(--main-color);--button-primary-bg-active: #a32e00;--button-primary-bg-hover: #be3600;--button-primary-text: #fff;--button-quaternary-bg: #fff;--button-quaternary-bg-active: #e4e4e7;--button-quaternary-bg-hover: #f4f4f5;--button-quaternary-text: #18181b;--button-secondary-bg: transparent;--button-secondary-bg-active: #fadcc0;--button-secondary-bg-hover: #ffedd5;--button-secondary-border: #ad3100;--button-secondary-text: #ad3100;--button-tertiary-bg: #fff2e1;--button-tertiary-bg-active: #fed7aa;--button-tertiary-bg-hover: #ffedd5;--button-tertiary-text: #ad3100;--capability-chip-bg: #f0f6ff;--capability-chip-border: #d8e6ff;--capability-chip-text: #002e99;--container-gutter-default: 16px;--container-gutter-lg: 32px;--container-max-2xl: 1360px;--foreground: #000;--logo-fallback-0-bg: #eff6ff;--logo-fallback-0-text: #1d4ed8;--logo-fallback-1-bg: #f0fdf4;--logo-fallback-1-text: #15803d;--logo-fallback-2-bg: #fffbeb;--logo-fallback-2-text: #b45309;--logo-fallback-3-bg: #faf5ff;--logo-fallback-3-text: #7e22ce;--logo-fallback-4-bg: #fff1f2;--logo-fallback-4-text: #be123c;--logo-fallback-5-bg: #ecfeff;--logo-fallback-5-text: #0e7490;--status-in-progress: #f0b400;--status-in-progress-bg: #fff4d1;--status-in-progress-text: #7e6612;--status-live: #2ba027;--status-live-bg: #dbf6da;--status-live-text: #207c40;--surface-1: #fff;--surface-2: #f5f5f5;--surface-warm: #f1f0ec;--tag-neutral-bg: #f6f7fa;--tag-neutral-border: #f0f2f6;--tag-neutral-text: #3f4d67;--text-muted: #404040;--text-soft: #666c79;--text-strong: #171717;--text-subtle: #9ca3af}html.dark{--accent: rgb(var(--primary-light));--link-active: #c96f28;--link-hover: #f0a266}"},{"filePath":"snippets/general/card.css","content":".pr-card-group{container-type:inline-size;display:grid;gap:var(--space-4, 16px);margin:var(--space-4, 16px) 0}.pr-card-group--cols-1{grid-template-columns:1fr}.pr-card-group--cols-2{grid-template-columns:repeat(2, minmax(0, 1fr))}.pr-card-group--cols-3{grid-template-columns:repeat(3, minmax(0, 1fr))}.pr-card-group--cols-4{grid-template-columns:repeat(4, minmax(0, 1fr))}@container (max-width: 620px){.pr-card-group--cols-3,.pr-card-group--cols-4{grid-template-columns:repeat(2, minmax(0, 1fr))}}@container (max-width: 340px){.pr-card-group{grid-template-columns:1fr}}.pr-card{display:flex;flex-direction:column;height:100%;overflow:hidden;border:1px solid #e5e5e5;border-radius:1rem;background-color:#fff;box-shadow:0 1px 2px 0 rgb(0 0 0 / 0.05);text-decoration:none;transition:transform 0.2s ease,\n background 0.2s ease,\n box-shadow 0.2s ease}.pr-card:hover{background-color:#f5f5f5;box-shadow:0 10px 15px -3px rgb(0 0 0 / 0.1),\n 0 4px 6px -4px rgb(0 0 0 / 0.1)}.pr-card__image{display:block;background-size:cover;width:100%;height:auto;aspect-ratio:16 / 9;margin:0;object-fit:cover;background-color:#f3f4f6}.pr-card__body{display:flex;flex-direction:column;gap:0.5rem;height:100%;padding:1.5rem}.pr-card__header{display:flex;align-items:center;gap:0.5rem}.pr-card__icon{display:flex;flex-shrink:0;align-items:center;justify-content:center;width:2.5rem;height:2.5rem;border-radius:1rem;background-color:rgb(var(--primary) / 0.1);color:var(--accent)}.pr-card__body:not(:first-child){border-top:1px solid #e5e5e5}.pr-card__title{margin:0;font-size:1.25rem;font-weight:600;line-height:1.25rem;color:var(--foreground)}.pr-card__text{margin:0;font-size:0.875rem;font-weight:400;line-height:1.5rem;color:var(--text-muted)}.dark .pr-card{border-color:#262626;background-color:#171717}.dark .pr-card:hover,.dark .pr-card__image{background-color:#262626}.dark .pr-card__body:not(:first-child){border-top-color:#404040}.dark .pr-card__icon{background-color:#262626}.dark .pr-card__title{color:#fff}.dark .pr-card__text{color:#f5f5f5}.pr-card.hover-zoom{transform:scale(1);\u0026:hover,\u0026:focus{transform:scale(1.05) translateY(-2%)}}@media (prefers-reduced-motion: reduce){.pr-card.hover-zoom{transform:none;\u0026:hover,\u0026:focus{transform:none}}}.provider-card{display:flex;align-items:center;gap:0.75rem;text-align:left}.provider-card-logo{display:block;width:2.5rem;height:2.5rem;flex-shrink:0;overflow:hidden;--tile-radius: 0.5rem;border-radius:var(--tile-radius)}.provider-card-logo img{width:100%;height:100%;margin:0;object-fit:contain}.provider-card-logo-fallback{display:flex;align-items:center;justify-content:center;width:100%;height:100%;background:var(--tag-neutral-bg);color:var(--tag-neutral-text);font-size:1.25rem;font-weight:600;line-height:1}.provider-card-name,.provider-card-type{margin:0}.provider-card-name{font-weight:600}.provider-card-type{font-size:0.875rem;line-height:1.25rem;color:rgb(var(--gray-500))}.dark .provider-card-type{color:rgb(var(--gray-400))}"},{"filePath":"snippets/payment-methods/explorer.css","content":".payment-methods-explorer:empty{min-height:3000px}.payment-method-logo{display:inline-flex;width:28px;height:28px;flex-shrink:0;overflow:hidden;--tile-radius: 0.375rem;border-radius:var(--tile-radius)}.payment-method-logo img{width:100%;height:100%;margin:0;object-fit:contain}"},{"filePath":"snippets/integrations/filterable-list.css","content":".integrations-filter{container-type:inline-size}.integrations-filter:empty::before{content:\"\";display:block;height:184px}@container (min-width: 310px){.integrations-filter:empty::before{height:140px}}@container (min-width: 364px){.integrations-filter:empty::before{height:96px}}@container (min-width: 665px){.integrations-filter:empty::before{height:52px}}.integration-card{display:flex;flex-direction:column}.integration-card>.card{flex:1}.integration-card[hidden]{display:none!important}"}],"page":{"pagePath":"reference/getpayment","slug":"/reference/getpayment","pageMetadata":{"title":"Get payment by ID","description":"Retrieve a payment by ID with its status, captured and refunded amounts, and provider details, and optionally the instrument and payment token.","deprecated":null,"version":null,"sidebarTitle":"Get payment by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}","href":"/reference/getpayment","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a payment by ID with its status, captured and refunded amounts, and provider details, and optionally the instrument and payment token.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get payment by ID","description":"Retrieve a payment by ID with its status, captured and refunded amounts, and provider details, and optionally the instrument and payment token.","deprecated":null,"version":null,"sidebarTitle":"Get payment by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}","href":"/reference/getpayment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/payrails-42074109/138fc948c6832630/consent.js","/_mintlify/custom/payrails-42074109/6a6f8c8ba4227cb9/same-tab-links.js","/_mintlify/custom/payrails-42074109/6e438b650fe2798f/noindex-other-hosts.js"],"openApiReferenceData":{"operation":{"summary":"Get payment by ID","x-mint":{"metadata":{"description":"Retrieve a payment by ID with its status, captured and refunded amounts, and provider details, and optionally the instrument and payment token.","sidebarTitle":"Get payment by ID"},"href":"/reference/getpayment"},"operationId":"getPayment","description":"Retrieve a payment by ID with its status, captured and refunded amounts, and provider details, and optionally the instrument and payment token.","tags":["Payments"],"security":["490f75db-98b4-44a6-86f9-5a228ed6d1e0"],"parameters":["83cc87ec-73e0-445b-bf38-4b8efc605a28","0928312a-4701-43ae-a59c-9a70095fcf18","db7aa0ad-9f60-4221-aeb2-c17c603a269e","79c0abbd-2ed0-4562-85ae-badb394ab539","f746b153-b587-4ce1-9d63-7770e6c5b299"],"responses":{"200":"79c57406-d665-4d11-953b-a6f89a1e896c","400":"27c297db-9bad-4919-abd1-3891644e2ad5","401":"5987e8ca-9cd5-4cbb-a19f-e3494caec195","403":"6fc803bd-8f73-4a8c-85b2-7a9e50bbe214","404":"3e9768ce-eba5-4759-8afc-2f84eab29723","429":"6624d83d-3b1a-4191-b5ce-df12142aeaca"},"method":"get","type":"path","servers":["2b65d804-16d0-4243-bffd-86c8d2fd3767"],"path":"/payment/payments/{paymentId}","baseUrlOptions":["https://api.eu.staging.payrails.io"],"title":"Get payment by ID","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"83cc87ec-73e0-445b-bf38-4b8efc605a28":{"name":"paymentId","in":"path","description":"Identifier of the resource in Payrails.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Identifier of the resource in Payrails.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"d5454c2f-ae5e-44f3-8edf-f6dad64f005f"},"0928312a-4701-43ae-a59c-9a70095fcf18":{"name":"includeInstrument","in":"query","schema":{"type":"boolean","default":false,"description":"Boolean indicating if the payment instrument should be included in the response.","uniqueKey":"","typeLabel":"boolean"},"description":"Boolean indicating if the payment instrument should be included in the response."},"db7aa0ad-9f60-4221-aeb2-c17c603a269e":{"name":"includePaymentToken","in":"query","schema":{"type":"boolean","default":false,"description":"Boolean indicating if the instrument payment token should be included in the response.","uniqueKey":"","typeLabel":"boolean"},"description":"Boolean indicating if the instrument payment token should be included in the response."},"79c0abbd-2ed0-4562-85ae-badb394ab539":{"name":"includeProviderAccountDisplayName","in":"query","schema":{"type":"boolean","default":false,"description":"Boolean indicating if the provider account display name should be included in the response.","uniqueKey":"","typeLabel":"boolean"},"description":"Boolean indicating if the provider account display name should be included in the response."},"f746b153-b587-4ce1-9d63-7770e6c5b299":{"name":"includeHolderReference","in":"query","schema":{"type":"boolean","default":false,"description":"Boolean indicating if the holder reference should be included in the response.","uniqueKey":"","typeLabel":"boolean"},"description":"Boolean indicating if the holder reference should be included in the response."}},"responses":{"79c57406-d665-4d11-953b-a6f89a1e896c":{"description":"Payment entity found, and all details are included.","content":{"application/json":{"schema":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the Payment in Payrails.","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Current status of the Payment in Payrails. More information can be found [here](https://docs.payrails.com/docs/resources/payments/payment-status).","enum":["Created","Pending","Unknown","Failed","Expired","Preauthorized","Authorized","Canceled","Captured","Refunded"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"Exact date and time when the Payment was created in Payrails. Possibly differs slightly from the date in the PSP.","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"providerId":{"type":"string","format":"uuid","description":"Unique identifier of the Provider that was used to process the Payment.","uniqueKey":"providerId","typeLabel":"string\u003cuuid>"},"paymentMethodType":{"type":"string","description":"Type of payment method used to process the payment.","uniqueKey":"paymentMethodType","typeLabel":"string"},"providerIntegrationType":{"type":"string","description":"Type of integration used to process the payment (in case the payment provider supports multiple).","uniqueKey":"providerIntegrationType","typeLabel":"string"},"providerName":{"type":"string","description":"Name of the Provider that was used to process the Payment, e.g. Adyen, Checkout, Stripe.","uniqueKey":"providerName","typeLabel":"string"},"providerReference":{"type":"string","description":"Unique identifier of the Payment in an external system, e.g. PSP.","uniqueKey":"providerReference","typeLabel":"string"},"providerConfigId":{"type":"string","format":"uuid","description":"Unique identifier of the merchant-specific Provider Configuration that was used to process the Payment. This can include the set of credentials used, the merchant account, country, vertical, etc.","uniqueKey":"providerConfigId","typeLabel":"string\u003cuuid>"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder that is involved in the Payment.","uniqueKey":"holderId","typeLabel":"string\u003cuuid>"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"amount.currency","typeLabel":"string"}},"description":"Amount of the Payment.","uniqueKey":"amount","typeLabel":"object"},"instrumentId":{"type":"string","format":"uuid","description":"Unique identifier of the Instrument that was used for the Payment in Payrails.","uniqueKey":"instrumentId","typeLabel":"string\u003cuuid>"},"instrumentTokenId":{"type":"string","format":"uuid","description":"Unique identifier of the specific Token inside the Instrument used for the Payment in Payrails.","uniqueKey":"instrumentTokenId","typeLabel":"string\u003cuuid>"},"instrument":{"type":"object","required":["id","holderId","paymentMethod","status","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Id of the instrument.","isRequired":true,"uniqueKey":"instrument.id","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","description":"Date and time when the Instrument was created in Payrails.","isRequired":true,"uniqueKey":"instrument.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the Instrument was last updated.","isRequired":true,"uniqueKey":"instrument.updatedAt","typeLabel":"string\u003cdate-time>"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder in Payrails.","isRequired":true,"uniqueKey":"instrument.holderId","typeLabel":"string\u003cuuid>"},"paymentMethod":{"type":"string","description":"Represents the payment method type.","enum":["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","sbp","wero"],"isRequired":true,"uniqueKey":"instrument.paymentMethod","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Status of the instrument.","enum":["created","deleted","enabled","disabled","transient"],"isRequired":true,"uniqueKey":"instrument.status","typeLabel":"enum\u003cstring>"},"displayName":{"type":"string","description":"Instrument name suitable for display.","uniqueKey":"instrument.displayName","typeLabel":"string"},"description":{"type":"string","description":"Description of the instrument.","uniqueKey":"instrument.description","typeLabel":"string"},"default":{"oneOf":[{"type":"boolean","description":"True if this instrument is set as default for the holder.","uniqueKey":"instrument.default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True if this instrument is set as default for the holder.","uniqueKey":"instrument.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"instrument.default","typeLabel":"boolean | null"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the instrument.","uniqueKey":"instrument.merchantReference","typeLabel":"string"},"fingerprint":{"type":"string","description":"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.","uniqueKey":"instrument.fingerprint","typeLabel":"string"},"futureUsage":{"type":"string","description":"Represents the future usage to define the payment flows that the stored instrument will be used for.","enum":["Subscription","CardOnFile","UnscheduledCardOnFile"],"uniqueKey":"instrument.futureUsage","typeLabel":"enum\u003cstring>"},"networkTransactionReference":{"type":"string","description":"Identifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.","uniqueKey":"instrument.networkTransactionReference","typeLabel":"string"},"transactionLinkId":{"type":"string","description":"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.","uniqueKey":"instrument.transactionLinkId","typeLabel":"string"},"data":{"oneOf":[{"type":"object","title":"Card","description":"Type-specific information about the instrument.","required":["network","bin","suffix"],"properties":{"network":{"type":"string","description":"Network of the instrument.","enum":["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"],"isRequired":true,"uniqueKey":"instrument.data.oneOf.0.network","typeLabel":"enum\u003cstring>"},"bin":{"type":"string","minLength":6,"maxLength":8,"description":"First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).","example":"416598","isRequired":true,"uniqueKey":"instrument.data.oneOf.0.bin","typeLabel":"string"},"suffix":{"type":"string","minLength":4,"maxLength":4,"description":"Last digits of the Card number.","isRequired":true,"uniqueKey":"instrument.data.oneOf.0.suffix","typeLabel":"string"},"preferredScheme":{"type":"string","description":"Network of the instrument.","enum":["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"],"uniqueKey":"instrument.data.oneOf.0.preferredScheme","typeLabel":"enum\u003cstring>"},"binLookup":{"description":"Information about an issuer by the given BIN (or IIN).","type":"object","required":["bin"],"properties":{"bin":{"type":"string","minLength":6,"maxLength":8,"description":"First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).","example":"416598","isRequired":true,"uniqueKey":"instrument.data.oneOf.0.binLookup.bin","typeLabel":"string"},"network":{"type":"string","description":"Network of the instrument.","enum":["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"],"uniqueKey":"instrument.data.oneOf.0.binLookup.network","typeLabel":"enum\u003cstring>"},"localNetwork":{"description":"Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.","type":"string","enum":["bancontact","cartesbancaires","dankort","mada"],"uniqueKey":"instrument.data.oneOf.0.binLookup.localNetwork","typeLabel":"enum\u003cstring>"},"issuer":{"type":"string","description":"Name of the bank or institution that issued the card.","uniqueKey":"instrument.data.oneOf.0.binLookup.issuer","typeLabel":"string"},"issuerCountry":{"description":"Country of the bank or institution that issued the card.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.0.binLookup.issuerCountry.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.0.binLookup.issuerCountry.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.0.binLookup.issuerCountry.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.0.binLookup.issuerCountry","typeLabel":"object"},"segment":{"type":"string","description":"Segment of the card, e.g. gold, black, business.","uniqueKey":"instrument.data.oneOf.0.binLookup.segment","typeLabel":"string"},"type":{"type":"string","description":"Type of the card, e.g. credit, debit, prepaid, gift.","uniqueKey":"instrument.data.oneOf.0.binLookup.type","typeLabel":"string"},"typeDetails":{"type":"string","description":"More information about the card type, e.g. personal, commercial.","uniqueKey":"instrument.data.oneOf.0.binLookup.typeDetails","typeLabel":"string"},"isNetworkToken":{"type":"boolean","description":"Indicates whether the card credential represents a network token rather than a primary account number (PAN).\n","uniqueKey":"instrument.data.oneOf.0.binLookup.isNetworkToken","typeLabel":"boolean"},"isFlexCard":{"type":"boolean","description":"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.\n","uniqueKey":"instrument.data.oneOf.0.binLookup.isFlexCard","typeLabel":"boolean"}},"uniqueKey":"instrument.data.oneOf.0.binLookup","typeLabel":"object"},"billingAddress":{"description":"Billing Address of the instrument.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"instrument.data.oneOf.0.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"instrument.data.oneOf.0.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"instrument.data.oneOf.0.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"instrument.data.oneOf.0.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"instrument.data.oneOf.0.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"instrument.data.oneOf.0.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"instrument.data.oneOf.0.billingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.0.billingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.0.billingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.0.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.0.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.0.billingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.0.billingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"instrument.data.oneOf.0.billingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"instrument.data.oneOf.0.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.0.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"instrument.data.oneOf.0.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.0.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.0.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.0.billingAddress.email","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.0.billingAddress","typeLabel":"object"},"expiryMonth":{"type":"string","minLength":2,"maxLength":2,"description":"Expiry month of the Card.","uniqueKey":"instrument.data.oneOf.0.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","minLength":4,"maxLength":4,"description":"Expiry year of the Card.","uniqueKey":"instrument.data.oneOf.0.expiryYear","typeLabel":"string"},"holderName":{"type":"string","description":"Name of the owner of the Card.","uniqueKey":"instrument.data.oneOf.0.holderName","typeLabel":"string"},"taxId":{"type":"string","description":"Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument.","uniqueKey":"instrument.data.oneOf.0.taxId","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.0","typeLabel":"Card · object"},{"type":"object","title":"BankAccount","description":"Type-specific information about the instrument.","properties":{"holder":{"type":"object","description":"The data structure for a holder's personal information.","properties":{"firstName":{"type":"string","description":"The first name of the account holder.","uniqueKey":"instrument.data.oneOf.1.holder.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"The last name of the account holder.","uniqueKey":"instrument.data.oneOf.1.holder.lastName","typeLabel":"string"},"companyName":{"type":"string","description":"The company name for business holders.","uniqueKey":"instrument.data.oneOf.1.holder.companyName","typeLabel":"string"},"address":{"description":"The address of the account holder.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"instrument.data.oneOf.1.holder.address.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"instrument.data.oneOf.1.holder.address.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"instrument.data.oneOf.1.holder.address.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"instrument.data.oneOf.1.holder.address.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"instrument.data.oneOf.1.holder.address.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"instrument.data.oneOf.1.holder.address.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"instrument.data.oneOf.1.holder.address.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.1.holder.address.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.1.holder.address.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.1.holder.address.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.1.holder.address.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.1.holder.address.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.1.holder.address.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"instrument.data.oneOf.1.holder.address.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"instrument.data.oneOf.1.holder.address.phone.countryCode","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.1.holder.address.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"instrument.data.oneOf.1.holder.address.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.1.holder.address.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.1.holder.address.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.1.holder.address.email","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.1.holder.address","typeLabel":"object"},"email":{"type":"string","format":"email","description":"The email address of the account holder.","uniqueKey":"instrument.data.oneOf.1.holder.email","typeLabel":"string\u003cemail>"},"dob":{"type":"string","format":"date","description":"The date of birth of the account holder (YYYY-MM-DD).","uniqueKey":"instrument.data.oneOf.1.holder.dob","typeLabel":"string\u003cdate>"},"country":{"description":"The country of the account holder.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.1.holder.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.1.holder.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.1.holder.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.1.holder.country","typeLabel":"object"},"city":{"type":"string","description":"The city of the account holder.","uniqueKey":"instrument.data.oneOf.1.holder.city","typeLabel":"string"},"type":{"type":"string","enum":["individual","corporate"],"description":"The type of account holder.","uniqueKey":"instrument.data.oneOf.1.holder.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"instrument.data.oneOf.1.holder","typeLabel":"object"},"bank":{"type":"object","description":"The data structure for a bank's information.","properties":{"name":{"type":"string","description":"The name of the bank.","uniqueKey":"instrument.data.oneOf.1.bank.name","typeLabel":"string"},"branchCode":{"type":"string","description":"The branch code of the bank.","uniqueKey":"instrument.data.oneOf.1.bank.branchCode","typeLabel":"string"},"code":{"type":"string","description":"The bank code.","uniqueKey":"instrument.data.oneOf.1.bank.code","typeLabel":"string"},"address":{"description":"The address of the bank.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"instrument.data.oneOf.1.bank.address.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"instrument.data.oneOf.1.bank.address.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"instrument.data.oneOf.1.bank.address.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"instrument.data.oneOf.1.bank.address.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"instrument.data.oneOf.1.bank.address.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"instrument.data.oneOf.1.bank.address.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"instrument.data.oneOf.1.bank.address.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.1.bank.address.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.1.bank.address.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.1.bank.address.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.1.bank.address.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.1.bank.address.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.1.bank.address.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"instrument.data.oneOf.1.bank.address.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"instrument.data.oneOf.1.bank.address.phone.countryCode","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.1.bank.address.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"instrument.data.oneOf.1.bank.address.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.1.bank.address.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.1.bank.address.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.1.bank.address.email","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.1.bank.address","typeLabel":"object"},"swiftCode":{"type":"string","description":"The SWIFT/BIC code of the bank.","uniqueKey":"instrument.data.oneOf.1.bank.swiftCode","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.1.bank","typeLabel":"object"},"account":{"type":"object","description":"The data structure for an account's information.","properties":{"number":{"type":"string","description":"The bank account number.","uniqueKey":"instrument.data.oneOf.1.account.number","typeLabel":"string"},"iban":{"type":"string","description":"The International Bank Account Number (IBAN).","uniqueKey":"instrument.data.oneOf.1.account.iban","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"USD","description":"ISO 3-letter currency code.","uniqueKey":"instrument.data.oneOf.1.account.currency","typeLabel":"string"},"country":{"description":"The country of the account.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.1.account.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.1.account.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.1.account.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.1.account.country","typeLabel":"object"},"type":{"type":"string","enum":["savings","current"],"description":"The type of bank account.","uniqueKey":"instrument.data.oneOf.1.account.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"instrument.data.oneOf.1.account","typeLabel":"object"}},"uniqueKey":"instrument.data.oneOf.1","typeLabel":"BankAccount · object"},{"type":"object","title":"PayPal","description":"Type-specific information about the instrument.","properties":{"email":{"type":"string","description":"Email of the PayPal account.","uniqueKey":"instrument.data.oneOf.2.email","typeLabel":"string"},"payerId":{"type":"string","description":"ID of the PayPal payer account.","uniqueKey":"instrument.data.oneOf.2.payerId","typeLabel":"string"},"billingAddress":{"description":"Billing Address of the instrument.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"instrument.data.oneOf.2.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"instrument.data.oneOf.2.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"instrument.data.oneOf.2.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"instrument.data.oneOf.2.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"instrument.data.oneOf.2.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"instrument.data.oneOf.2.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"instrument.data.oneOf.2.billingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.2.billingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.2.billingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.2.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.2.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.2.billingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.2.billingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"instrument.data.oneOf.2.billingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"instrument.data.oneOf.2.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.2.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"instrument.data.oneOf.2.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.2.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.2.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.2.billingAddress.email","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.2.billingAddress","typeLabel":"object"}},"uniqueKey":"instrument.data.oneOf.2","typeLabel":"PayPal · object"},{"type":"object","title":"GooglePay","description":"Type-specific information about the instrument.","required":["network","suffix"],"properties":{"network":{"type":"string","description":"Network of the instrument.","enum":["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"],"isRequired":true,"uniqueKey":"instrument.data.oneOf.3.network","typeLabel":"enum\u003cstring>"},"suffix":{"type":"string","minLength":4,"maxLength":4,"description":"Last digits of the Card number.","isRequired":true,"uniqueKey":"instrument.data.oneOf.3.suffix","typeLabel":"string"},"networkDisplayName":{"type":"string","description":"Display-friendly name of the network.","uniqueKey":"instrument.data.oneOf.3.networkDisplayName","typeLabel":"string"},"binLookup":{"description":"Information about an issuer.","type":"object","properties":{"network":{"type":"string","description":"Network of the instrument.","enum":["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"],"uniqueKey":"instrument.data.oneOf.3.binLookup.network","typeLabel":"enum\u003cstring>"},"localNetwork":{"description":"Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.","type":"string","enum":["bancontact","cartesbancaires","dankort","mada"],"uniqueKey":"instrument.data.oneOf.3.binLookup.localNetwork","typeLabel":"enum\u003cstring>"},"issuer":{"type":"string","description":"Name of the bank or institution that issued the card.","uniqueKey":"instrument.data.oneOf.3.binLookup.issuer","typeLabel":"string"},"issuerCountry":{"description":"Country of the bank or institution that issued the card.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.3.binLookup.issuerCountry.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.3.binLookup.issuerCountry.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.3.binLookup.issuerCountry.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.3.binLookup.issuerCountry","typeLabel":"object"},"segment":{"type":"string","description":"Segment of the card, e.g. gold, black, business.","uniqueKey":"instrument.data.oneOf.3.binLookup.segment","typeLabel":"string"},"type":{"type":"string","description":"Type of the card, e.g. credit, debit, prepaid, gift.","uniqueKey":"instrument.data.oneOf.3.binLookup.type","typeLabel":"string"},"typeDetails":{"type":"string","description":"More information about the card type, e.g. personal, commercial.","uniqueKey":"instrument.data.oneOf.3.binLookup.typeDetails","typeLabel":"string"},"isNetworkToken":{"type":"boolean","description":"Indicates whether the card credential represents a network token rather than a primary account number (PAN).\n","uniqueKey":"instrument.data.oneOf.3.binLookup.isNetworkToken","typeLabel":"boolean"},"isFlexCard":{"type":"boolean","description":"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.\n","uniqueKey":"instrument.data.oneOf.3.binLookup.isFlexCard","typeLabel":"boolean"}},"uniqueKey":"instrument.data.oneOf.3.binLookup","typeLabel":"object"},"billingAddress":{"description":"Billing Address of the instrument.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"instrument.data.oneOf.3.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"instrument.data.oneOf.3.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"instrument.data.oneOf.3.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"instrument.data.oneOf.3.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"instrument.data.oneOf.3.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"instrument.data.oneOf.3.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"instrument.data.oneOf.3.billingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.3.billingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.3.billingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.3.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.3.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.3.billingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.3.billingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"instrument.data.oneOf.3.billingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"instrument.data.oneOf.3.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.3.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"instrument.data.oneOf.3.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.3.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.3.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.3.billingAddress.email","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.3.billingAddress","typeLabel":"object"},"shippingAddress":{"description":"Shipping Address provided by the wallet.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.3.shippingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.3.shippingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.3.shippingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"instrument.data.oneOf.3.shippingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.3.shippingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.3.shippingAddress.email","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.3.shippingAddress","typeLabel":"object"},"expiryMonth":{"type":"string","minLength":2,"maxLength":2,"description":"Expiry month of the Card.","uniqueKey":"instrument.data.oneOf.3.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","minLength":4,"maxLength":4,"description":"Expiry year of the Card.","uniqueKey":"instrument.data.oneOf.3.expiryYear","typeLabel":"string"},"paymentToken":{"type":"string","description":"One-time payment token sent by client-side for execution of payment on backend.","uniqueKey":"instrument.data.oneOf.3.paymentToken","typeLabel":"string"},"eci":{"type":"string","description":"Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder.","uniqueKey":"instrument.data.oneOf.3.eci","typeLabel":"string"},"cardHolderAuthenticated":{"type":"boolean","description":"Indicates that identification and verifications (ID\u0026V) was performed on the returned payment credential.","uniqueKey":"instrument.data.oneOf.3.cardHolderAuthenticated","typeLabel":"boolean"},"googleMessageId":{"type":"string","description":"Unique identifier for the Google Pay message.","uniqueKey":"instrument.data.oneOf.3.googleMessageId","typeLabel":"string"},"googleMessageExpirationId":{"type":"string","description":"Expiration time for the Google Pay message.","uniqueKey":"instrument.data.oneOf.3.googleMessageExpirationId","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.3","typeLabel":"GooglePay · object"},{"type":"object","title":"ApplePay","description":"Type-specific information about the instrument.","required":["network","suffix"],"properties":{"network":{"type":"string","description":"Network of the instrument.","enum":["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"],"isRequired":true,"uniqueKey":"instrument.data.oneOf.4.network","typeLabel":"enum\u003cstring>"},"suffix":{"type":"string","minLength":4,"maxLength":4,"description":"Last digits of the Card number.","isRequired":true,"uniqueKey":"instrument.data.oneOf.4.suffix","typeLabel":"string"},"networkDisplayName":{"type":"string","description":"Display-friendly name of the network.","uniqueKey":"instrument.data.oneOf.4.networkDisplayName","typeLabel":"string"},"binLookup":{"description":"Information about an issuer.","type":"object","properties":{"network":{"type":"string","description":"Network of the instrument.","enum":["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"],"uniqueKey":"instrument.data.oneOf.4.binLookup.network","typeLabel":"enum\u003cstring>"},"localNetwork":{"description":"Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.","type":"string","enum":["bancontact","cartesbancaires","dankort","mada"],"uniqueKey":"instrument.data.oneOf.4.binLookup.localNetwork","typeLabel":"enum\u003cstring>"},"issuer":{"type":"string","description":"Name of the bank or institution that issued the card.","uniqueKey":"instrument.data.oneOf.4.binLookup.issuer","typeLabel":"string"},"issuerCountry":{"description":"Country of the bank or institution that issued the card.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.4.binLookup.issuerCountry.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.4.binLookup.issuerCountry.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.4.binLookup.issuerCountry.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.4.binLookup.issuerCountry","typeLabel":"object"},"segment":{"type":"string","description":"Segment of the card, e.g. gold, black, business.","uniqueKey":"instrument.data.oneOf.4.binLookup.segment","typeLabel":"string"},"type":{"type":"string","description":"Type of the card, e.g. credit, debit, prepaid, gift.","uniqueKey":"instrument.data.oneOf.4.binLookup.type","typeLabel":"string"},"typeDetails":{"type":"string","description":"More information about the card type, e.g. personal, commercial.","uniqueKey":"instrument.data.oneOf.4.binLookup.typeDetails","typeLabel":"string"},"isNetworkToken":{"type":"boolean","description":"Indicates whether the card credential represents a network token rather than a primary account number (PAN).\n","uniqueKey":"instrument.data.oneOf.4.binLookup.isNetworkToken","typeLabel":"boolean"},"isFlexCard":{"type":"boolean","description":"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.\n","uniqueKey":"instrument.data.oneOf.4.binLookup.isFlexCard","typeLabel":"boolean"}},"uniqueKey":"instrument.data.oneOf.4.binLookup","typeLabel":"object"},"billingAddress":{"description":"Billing Address of the instrument.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"instrument.data.oneOf.4.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"instrument.data.oneOf.4.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"instrument.data.oneOf.4.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"instrument.data.oneOf.4.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"instrument.data.oneOf.4.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"instrument.data.oneOf.4.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"instrument.data.oneOf.4.billingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.4.billingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.4.billingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.4.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.4.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.4.billingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.4.billingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"instrument.data.oneOf.4.billingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"instrument.data.oneOf.4.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.4.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"instrument.data.oneOf.4.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.4.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.4.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.4.billingAddress.email","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.4.billingAddress","typeLabel":"object"},"shippingAddress":{"description":"Shipping Address provided by the wallet.","type":"object","properties":{"street":{"type":"string","description":"The name of the street of a postal address.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.state","typeLabel":"string"},"country":{"description":"The country where the address is in.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.4.shippingAddress.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.4.shippingAddress.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.4.shippingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.latitude","typeLabel":"number\u003cfloat>"},"longitude":{"type":"number","format":"float","description":"Longitude of the address in the GPS coordinate system.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.longitude","typeLabel":"number\u003cfloat>"},"phone":{"description":"The phone to contact in the address (can be different that the customer's).","type":"object","required":["number"],"properties":{"number":{"type":"string","pattern":"^[0-9]+$","description":"The local number of the phone, such that `countryCode` + `number` can be dialed.","isRequired":true,"uniqueKey":"instrument.data.oneOf.4.shippingAddress.phone.number","typeLabel":"string"},"countryCode":{"type":"string","pattern":"^\\+?[0-9]+$","description":"International prefix of the phone, if known separately.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.4.shippingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"instrument.data.oneOf.4.shippingAddress.email","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.4.shippingAddress","typeLabel":"object"},"expiryMonth":{"type":"string","minLength":2,"maxLength":2,"description":"Expiry month of the Card.","uniqueKey":"instrument.data.oneOf.4.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","minLength":4,"maxLength":4,"description":"Expiry year of the Card.","uniqueKey":"instrument.data.oneOf.4.expiryYear","typeLabel":"string"},"paymentToken":{"type":"string","description":"One-time payment token sent by client-side for execution of payment on backend.","uniqueKey":"instrument.data.oneOf.4.paymentToken","typeLabel":"string"},"eci":{"type":"string","description":"Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder.","uniqueKey":"instrument.data.oneOf.4.eci","typeLabel":"string"},"cardHolderAuthenticated":{"type":"boolean","description":"Indicates that identification and verifications (ID\u0026V) was performed on the returned payment credential.","uniqueKey":"instrument.data.oneOf.4.cardHolderAuthenticated","typeLabel":"boolean"}},"uniqueKey":"instrument.data.oneOf.4","typeLabel":"ApplePay · object"},{"type":"object","title":"DCB","description":"Type-specific information about the instrument.","properties":{"msisdn":{"type":"string","description":"Mobile number of the holder MSISDN Stands for Mobile Station International Subscriber Directory Number.","uniqueKey":"instrument.data.oneOf.5.msisdn","typeLabel":"string"},"msisdnTail":{"type":"string","description":"Last 4 digits of the mobile number of the holder.","uniqueKey":"instrument.data.oneOf.5.msisdnTail","typeLabel":"string"},"country":{"description":"Country of the holder.","type":"object","required":["code"],"properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"instrument.data.oneOf.5.country.code","typeLabel":"string"},"iso3":{"type":"string","description":"ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.","pattern":"^[A-Z]{3}$","uniqueKey":"instrument.data.oneOf.5.country.iso3","typeLabel":"string"},"name":{"type":"string","description":"The English name of the country. Returned by Payrails, but not interpreted in requests.","uniqueKey":"instrument.data.oneOf.5.country.name","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.5.country","typeLabel":"object"},"carrierNetwork":{"type":"string","description":"Carrier network of the msisdn.","uniqueKey":"instrument.data.oneOf.5.carrierNetwork","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.5","typeLabel":"DCB · object"},{"type":"object","title":"MBWayDirect","description":"Type-specific information about the instrument.","properties":{"phone":{"type":"object","description":"Mobile number the payer confirms MB WAY payments with.","properties":{"countryCode":{"type":"string","description":"International dialling code, digits only.","example":"351","uniqueKey":"instrument.data.oneOf.6.phone.countryCode","typeLabel":"string"},"number":{"type":"string","description":"National number, digits only.","example":"912345678","uniqueKey":"instrument.data.oneOf.6.phone.number","typeLabel":"string"}},"uniqueKey":"instrument.data.oneOf.6.phone","typeLabel":"object"}},"uniqueKey":"instrument.data.oneOf.6","typeLabel":"MBWayDirect · object"}],"uniqueKey":"instrument.data","typeLabel":"Card · object | BankAccount · object | PayPal · object | GooglePay · object | ApplePay · object | DCB · object | MBWayDirect · object"}},"description":"Optionally included details about the instrument used for the payment.","uniqueKey":"instrument","typeLabel":"object"},"instrumentToken":{"type":"object","required":["id","instrumentId","providerId","reference","status","type","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Id of the token in Payrails.","isRequired":true,"uniqueKey":"instrumentToken.id","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","description":"Date and time when the Token was created in Payrails.","isRequired":true,"uniqueKey":"instrumentToken.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the Token was last updated.","isRequired":true,"uniqueKey":"instrumentToken.updatedAt","typeLabel":"string\u003cdate-time>"},"instrumentId":{"type":"string","format":"uuid","description":"Id of the payment instrument the token belongs to.","isRequired":true,"uniqueKey":"instrumentToken.instrumentId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Status of the token.","enum":["created","enabled","disabled","deleted"],"isRequired":true,"uniqueKey":"instrumentToken.status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Type of the token.","enum":["network","vault","psp","networkOffers","networkGateway"],"isRequired":true,"uniqueKey":"instrumentToken.type","typeLabel":"enum\u003cstring>"},"providerId":{"type":"string","format":"uuid","description":"Id of the provider the token belongs to.","isRequired":true,"uniqueKey":"instrumentToken.providerId","typeLabel":"string\u003cuuid>"},"reference":{"type":"string","description":"Unique identifier of the token in the provider's system.","isRequired":true,"uniqueKey":"instrumentToken.reference","typeLabel":"string"},"providerConfigId":{"type":"string","format":"uuid","description":"Id of the configuration in the provider the token belongs to.","uniqueKey":"instrumentToken.providerConfigId","typeLabel":"string\u003cuuid>"},"meta":{"description":"Any merchant or provider-specific data that should be stored for context in the token.","type":"object","additionalProperties":true,"uniqueKey":"instrumentToken.meta","typeLabel":"object"}},"description":"Optionally included details about the instrument token used for the payment.","uniqueKey":"instrumentToken","typeLabel":"object"},"transactionReference":{"type":"string","description":"Merchant-specific identifier of the execution. This can be used for searching for the Payment later.","uniqueKey":"transactionReference","typeLabel":"string"},"transactionElementReference":{"type":"string","description":"Identifier of the step in the Workflow that led to this Payment.","uniqueKey":"transactionElementReference","typeLabel":"string"},"pspRedirectUrl":{"type":"string","description":"In case a redirection process is needed during the Payment, this is the URL where the PSP requested Payrails to redirect the user to.","uniqueKey":"pspRedirectUrl","typeLabel":"string"},"capturedAmount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"capturedAmount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"capturedAmount.currency","typeLabel":"string"}},"description":"Amount that was captured from the Payment. If no capture is initiated for the payment, the value will be 0 until a successful capture occurs.","uniqueKey":"capturedAmount","typeLabel":"object"},"refundedAmount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"refundedAmount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"refundedAmount.currency","typeLabel":"string"}},"description":"Amount that was refunded from the Payment. If multiple partial refunds have been made, this will be the sum of them. If no refund is initiated for the payment, the value will remain 0 until a successful refund occurs.","uniqueKey":"refundedAmount","typeLabel":"object"},"availableAmount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"availableAmount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"availableAmount.currency","typeLabel":"string"}},"description":"Amount still available to refund from the Payment, i.e. capturedAmount minus refundedAmount. Reflects partial captures, so refunds are never allowed to exceed what was actually captured.","uniqueKey":"availableAmount","typeLabel":"object"},"merchantReturnUrl":{"type":"string","description":"In case a redirection process is needed during the Payment, Payrails will return to this merchant-specific URL after it finished.","uniqueKey":"merchantReturnUrl","typeLabel":"string"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.","uniqueKey":"merchantReference","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"description":"Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our [Meta Fields guide](https://docs.payrails.com/docs/orchestration/meta-fields). See [Meta](/reference/meta) for every field.","properties":{"order":{"type":"object","description":"The order being placed on your system. See [Meta.order](/reference/meta#schema-order) for every field.","uniqueKey":"meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"meta.customer","typeLabel":"object"},"clientContext":{"type":"object","description":"Data describing the customer's device or browser. See [Meta.clientContext](/reference/meta#schema-client-context) for every field.","uniqueKey":"meta.clientContext","typeLabel":"object"},"vendor":{"type":"object","description":"Description of a vendor that provides the order.\n See [Meta.vendor](/reference/meta#schema-vendor) for every field.","uniqueKey":"meta.vendor","typeLabel":"object"},"risk":{"type":"object","description":"Configuration values for the risk prevention check. See [Meta.risk](/reference/meta#schema-risk) for every field.","uniqueKey":"meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"meta.subscription","typeLabel":"object"},"tags":{"type":"object","description":"Additional meta fields to be sent to the payment providers which support metadata / tags.\nFor example, sent to [Stripe as metadata](https://docs.stripe.com/api/metadata).\nBecause these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.\n","uniqueKey":"meta.tags","typeLabel":"object"},"paymentMethods":{"type":"object","description":"Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read.\n See [Meta.paymentMethods](/reference/meta#schema-payment-methods) for every field.","uniqueKey":"meta.paymentMethods","typeLabel":"object"},"upi":{"description":"Deprecated. Use paymentMethods.upi instead; this location is still read as a fallback and will be removed once integrations have migrated.\n See [Meta.upi](/reference/meta#schema-upi) for every field.","uniqueKey":"meta.upi","typeLabel":"any"}},"uniqueKey":"meta","typeLabel":"object"},"history":{"type":"array","description":"History of Payment Operations executed on the Payment.","items":{"type":"object","required":["id","result"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the Payment Operation in Payrails.","isRequired":true,"uniqueKey":"history.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"result":{"type":"string","description":"Result of the Operation according to Payrails mapping from the provider response.","enum":["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"],"isRequired":true,"uniqueKey":"history.items.[INDEX].result","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"Exact date and time when the Payment Operation was created in Payrails. Possibly differs slightly from the date in the PSP.","uniqueKey":"history.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Exact date and time when the Payment Operation was updated in Payrails. Possibly differs slightly from the date in the PSP.","uniqueKey":"history.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"paymentId":{"type":"string","format":"uuid","description":"Unique identifier of the Payment that this Operation belongs to in Payrails.","uniqueKey":"history.items.[INDEX].paymentId","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Operation Type that was executed in the Provider.","enum":["Authorize","Preauthorize","Capture","Cancel","Refund","Credit","SendNotification","CaptureNotification","RefundNotification","CancelNotification","AuthorizeNotification","ChargebackNotification","ChargebackReverseNotification","IssuerCommentsNotification","AcceptDispute","DefendDispute","SubmitEvidence","PullDispute","Get","Search","GetToken","Tokenize","DisableToken","Register","Generate3DS","Validate3DS","PayerAuthInit","PayerAuthCheckEnroll","PayerAuthValidate","RefundFailedNotification","RefundReversedNotification","CaptureFailedNotification","ValidateRedirect","RefundNotificationUpdated"],"uniqueKey":"history.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"Reason why the operation was done.","uniqueKey":"history.items.[INDEX].reason","typeLabel":"string"},"reasonDescription":{"type":"string","description":"Free-text description that came with the reason.","uniqueKey":"history.items.[INDEX].reasonDescription","typeLabel":"string"},"initiator":{"type":"object","description":"Who requested the operation. Only refunds requested through the refund endpoint carry it. It is absent on all other operations, including captures, cancels, a refund made by a cancel, and refunds made before attribution was introduced.","required":["type"],"properties":{"type":{"type":"string","enum":["user","client","system"],"description":"`user` is a portal user, `client` an API client, and `system` a refund that no caller requested, such as one triggered by an event or the internal API.","isRequired":true,"uniqueKey":"history.items.[INDEX].initiator.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Auth user ID for `user`, or the OAuth client ID for `client`. Absent for `system`, and for a user who could not be identified.","uniqueKey":"history.items.[INDEX].initiator.id","typeLabel":"string"},"email":{"type":"string","description":"Email of the user. Only returned with `includeInitiatorEmail=true` to portal users, for users that still exist.","uniqueKey":"history.items.[INDEX].initiator.email","typeLabel":"string"},"internal":{"type":"boolean","description":"Whether the user is Payrails support staff. Only returned with `includeInitiatorEmail=true` to portal users, for users that still exist.","uniqueKey":"history.items.[INDEX].initiator.internal","typeLabel":"boolean"}},"uniqueKey":"history.items.[INDEX].initiator","typeLabel":"object"},"providerReference":{"type":"string","description":"Unique identifier of the Payment Operation in an external system. Some PSPs provide a specific ID for each update in the Payment, but most of them use the same as the original Payment.","uniqueKey":"history.items.[INDEX].providerReference","typeLabel":"string"},"paymentStatus":{"type":"string","description":"The payment status just after the operation done.","uniqueKey":"history.items.[INDEX].paymentStatus","typeLabel":"string"},"amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","pattern":"[0-9]+(\\.[0-9]+)?","example":"12.50","description":"Decimal amount of the major currency unit. Can be any precision.","isRequired":true,"uniqueKey":"history.items.[INDEX].amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"history.items.[INDEX].amount.currency","typeLabel":"string"}},"uniqueKey":"history.items.[INDEX].amount","typeLabel":"object"},"responseCode":{"type":"string","description":"Original response code from the PSP, which Payrails interpreted for the result field.","uniqueKey":"history.items.[INDEX].responseCode","typeLabel":"string"},"requiredActionDetails":{"type":"object","description":"In case a Provider requests an action to continue executing an Operation, this object contains the necessary information for it.","properties":{"redirectUrl":{"type":"string","description":"The URL that the Merchant should redirect the user to.","uniqueKey":"history.items.[INDEX].requiredActionDetails.redirectUrl","typeLabel":"string"},"redirectMethod":{"type":"string","description":"The HTTP method that should be used when redirecting to the `redirectUrl`.","enum":["GET","POST"],"uniqueKey":"history.items.[INDEX].requiredActionDetails.redirectMethod","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","description":"Map of parameters that are necessary for the redirection. In case the `redirectMethod` is `GET`, these parameters can be appended in the query string, but if it's `POST`, they should be sent via form.","additionalProperties":{"type":"string","uniqueKey":"history.items.[INDEX].requiredActionDetails.parameters.additionalProperties","typeLabel":"string"},"uniqueKey":"history.items.[INDEX].requiredActionDetails.parameters","typeLabel":"object"}},"uniqueKey":"history.items.[INDEX].requiredActionDetails","typeLabel":"object"},"errorDetails":{"type":"string","description":"Error details from the provider.","uniqueKey":"history.items.[INDEX].errorDetails","typeLabel":"string"},"acquirerReference":{"type":"string","description":"Acquirer Reference Number (ARN) for the Payment Operation (only Refunds and Captures), which we receive from some of the Provider.","uniqueKey":"history.items.[INDEX].acquirerReference","typeLabel":"string"},"workspaceId":{"type":"string","format":"uuid","description":"Workspace ID that the workflow configuration belongs to.","uniqueKey":"history.items.[INDEX].workspaceId","typeLabel":"string\u003cuuid>"},"operationLogs":{"type":"array","items":{"type":"object","description":"Whenever there is an interaction with an external provider, Payrails records a Log to keep the exact information about what was sent and received.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the Payment Operation Log in Payrails.","uniqueKey":"history.items.[INDEX].operationLogs.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","description":"Exact date and time when the Payment Operation Log was created in Payrails. Possibly differs slightly from the date in the PSP.","uniqueKey":"history.items.[INDEX].operationLogs.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"operationId":{"type":"string","format":"uuid","description":"Unique identifier of the Payment Operation that this Log belongs to in Payrails.","uniqueKey":"history.items.[INDEX].operationLogs.items.[INDEX].operationId","typeLabel":"string\u003cuuid>"},"input":{"type":"string","description":"Original request object sent to the Provider.","uniqueKey":"history.items.[INDEX].operationLogs.items.[INDEX].input","typeLabel":"string"},"output":{"type":"string","description":"Original response object received from the Provider.","uniqueKey":"history.items.[INDEX].operationLogs.items.[INDEX].output","typeLabel":"string"},"workspaceId":{"type":"string","format":"uuid","description":"Workspace ID that the workflow configuration belongs to.","uniqueKey":"history.items.[INDEX].operationLogs.items.[INDEX].workspaceId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"history.items.[INDEX].operationLogs.items.[INDEX]","typeLabel":"object"},"description":"List of operation logs associated with this operation.","uniqueKey":"history.items.[INDEX].operationLogs","typeLabel":"object[]"},"providerLatency":{"type":"string","description":"Latency of the operation on the provider side.","uniqueKey":"history.items.[INDEX].providerLatency","typeLabel":"string"},"totalLatency":{"type":"string","description":"Total latency of the operation.","uniqueKey":"history.items.[INDEX].totalLatency","typeLabel":"string"}},"uniqueKey":"history.items.[INDEX]","typeLabel":"object"},"uniqueKey":"history","typeLabel":"object[]"},"providerAccountDisplayName":{"type":"string","description":"Display name of the Provider Account/Configuration that was used to process the Payment.","uniqueKey":"providerAccountDisplayName","typeLabel":"string"},"providerDisplayName":{"type":"string","description":"Display name of the Provider that was used to process the Payment.","uniqueKey":"providerDisplayName","typeLabel":"string"},"workspaceId":{"type":"string","description":"Workspace ID that the Payment belongs to.","uniqueKey":"workspaceId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"authorized":{"title":"authorized","description":"Payment is successfully authorized.","value":{"id":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","status":"Authorized","createdAt":"2022-04-22T17:53:36.814Z","providerId":"e96aa893-4458-43c6-b334-179cf73f5dba","providerName":"adyen","providerReference":"adyen-6389361285","providerConfigId":"5cc8f271-0059-43a3-b339-27712c997e30","holderId":"785380c9-1015-453d-82ab-d3386e27c05e","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","amount":{"value":"22.40","currency":"EUR"},"instrumentId":"15b0069a-913b-4224-b05a-056e89611a51","instrumentTokenId":"38fa0ee2-3f6e-41c1-8298-7398b2a93bd3","instrument":{"id":"15b0069a-913b-4224-b05a-056e89611a51","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","description":"Personal card.","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe"},"meta":{"communityCode":"GAP","userKey":"9890124569"}},"transactionReference":"order-671934582","transactionElementReference":"wkf-24-64313","pspRedirectUrl":"","merchantReturnUrl":"http://merchant.com/redirect-from/def456","merchantReference":"468b618d77ed","history":[{"id":"7314d8ea-ad96-4564-a954-8fc17584823b","createdAt":"2022-04-22T17:53:56.631Z","paymentId":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","type":"Authorize","providerReference":"adyen-auth-6389361285","amount":{"value":"22.40","currency":"EUR"},"result":"Success","responseCode":"Authorised","log":[{"id":"35773ce1-a5d6-41f4-a94f-3005ac12f8bf","createdAt":"2022-04-22T17:53:56.721Z","operationId":"7314d8ea-ad96-4564-a954-8fc17584823b","request":"{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"reference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"***REDACTED***\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"***REDACTED***\"\n },\n \"returnUrl\": \"http://payrails.com/redirect-from/def456\",\n \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n","response":"{\n \"additionalData\": {\n \"scaExemptionRequested\": \"transactionRiskAnalysis\"\n },\n \"pspReference\": \"adyen-6389361285\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"}]}]}},"failed":{"title":"failed","description":"Payment Failed because of an Insufficient Balance error.","value":{"id":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","status":"Failed","createdAt":"2022-04-22T17:53:36.814Z","providerId":"e96aa893-4458-43c6-b334-179cf73f5dba","providerName":"adyen","providerReference":"adyen-6389361285","providerConfigId":"5cc8f271-0059-43a3-b339-27712c997e30","holderId":"785380c9-1015-453d-82ab-d3386e27c05e","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","amount":{"value":"22.40","currency":"EUR"},"instrumentId":"15b0069a-913b-4224-b05a-056e89611a51","instrumentTokenId":"38fa0ee2-3f6e-41c1-8298-7398b2a93bd3","instrument":{"id":"15b0069a-913b-4224-b05a-056e89611a51","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","description":"Personal card.","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe"},"meta":{"communityCode":"GAP","userKey":"9890124569"}},"transactionReference":"order-671934582","transactionElementReference":"wkf-24-64313","pspRedirectUrl":"","merchantReturnUrl":"http://merchant.com/redirect-from/def456","merchantReference":"468b618d77ed","history":[{"id":"7314d8ea-ad96-4564-a954-8fc17584823b","createdAt":"2022-04-22T17:53:56.631Z","paymentId":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","type":"Authorize","providerReference":"adyen-auth-6389361285","amount":{"value":"22.40","currency":"EUR"},"result":"InsufficientBalance","responseCode":"Refused","log":[{"id":"35773ce1-a5d6-41f4-a94f-3005ac12f8bf","createdAt":"2022-04-22T17:53:56.721Z","operationId":"7314d8ea-ad96-4564-a954-8fc17584823b","request":"{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"reference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"***REDACTED***\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"***REDACTED***\"\n },\n \"returnUrl\": \"http://payrails.com/redirect-from/def456\",\n \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n","response":"{\n \"pspReference\": \"adyen-6389361285\",\n \"resultCode\": \"Refused\",\n \"refusalReason\": \"Not enough balance\",\n \"refusalReasonCode\": 12,\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"}]}]}},"3ds":{"title":"3ds","description":"Payment is Pending, waiting for a 3DS redirection.","value":{"id":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","status":"Pending","createdAt":"2022-04-22T17:53:36.814Z","providerId":"e96aa893-4458-43c6-b334-179cf73f5dba","providerName":"adyen","providerReference":"adyen-6389361285","providerConfigId":"5cc8f271-0059-43a3-b339-27712c997e30","holderId":"785380c9-1015-453d-82ab-d3386e27c05e","amount":{"value":"22.40","currency":"EUR"},"instrumentId":"15b0069a-913b-4224-b05a-056e89611a51","instrumentTokenId":"38fa0ee2-3f6e-41c1-8298-7398b2a93bd3","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","instrument":{"id":"15b0069a-913b-4224-b05a-056e89611a51","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","description":"Personal card.","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe"},"meta":{"communityCode":"GAP","userKey":"9890124569"}},"transactionReference":"order-671934582","transactionElementReference":"wkf-24-64313","pspRedirectUrl":"http://psp.com/redirect-to/abc123","merchantReturnUrl":"http://merchant.com/redirect-from/def456","merchantReference":"468b618d77ed","history":[{"id":"7314d8ea-ad96-4564-a954-8fc17584823b","createdAt":"2022-04-22T17:53:56.631Z","paymentId":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","type":"Authorize","providerReference":"adyen-auth-6389361285","amount":{"value":"22.40","currency":"EUR"},"result":"Pending","responseCode":"RedirectShopper","requiredActionDetails":{"redirectUrl":"http://payrails.com/redirect-to/abc123","redirectMethod":"GET","parameters":{"txId":"abc123"}},"log":[{"id":"35773ce1-a5d6-41f4-a94f-3005ac12f8bf","createdAt":"2022-04-22T17:53:56.721Z","operationId":"7314d8ea-ad96-4564-a954-8fc17584823b","request":"{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"reference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"***REDACTED***\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"***REDACTED***\"\n },\n \"returnUrl\": \"http://payrails.com/redirect-from/def456\",\n \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n","response":"{\n \"resultCode\": \"RedirectShopper\",\n \"action\": {\n \"paymentMethodType\": \"scheme\",\n \"url\": \"http://psp.com/redirect-to/abc123\",\n \"data\": {\n \"MD\": \"dk1sZ280MGhjQjErc1RoeVNIYnE1Zz09Idj5rdA8zaSpxWjIh5js4r2MKgme4SfmgW9gsV5bpIXolqyqQ3PBwwibWlaVX0uQjO-5bGjh5RpoOP6QJzWfJgwa25NpIfCDiM0TRmKDeCvA1K1ZRafOWHDYHLd7q1esXLfELRSistM3IlOkO62Dad0DFcOoVY1Y1__3EGJ5P17uOh86al61l1iQqGA1sPmIgCR5nrDjJYExfentCOqUuel9L3RJV2w2AnEObjGII8AnTrvWFjXv0hPveKNx4zMcl1m9i_dNkrFB5VXp6Ya7nntyeblpk2divKsvFIEY3j5DNH6RvozoHCjq2O5j53sLQivM9RjkfadbPxyV6uPZta5qaLDDIOsZUJaZHGXCicVCcbIlt0VOTRnHr7VVSq9ZTN7A6SFxln0sinwhfUZ6kb2yRq8kCKpat0Z0-RziUZkUWVgiIU1eDmIbaRFRbLQoZwIKHs9E3jjjuvTYW42BTQw_ebdq38t8eUeznFWmIOalTFwDEdbcCd-cgoIh-jse8yo_oSI8fDJMeku_wERtx2SrH_XCSfiacvp5mPtZtu9fZUOHY-G1_3O1UfprF9vlNWPbOb_QLjMu\",\n \"PaReq\": \"eNpVUu2OgjAQfBXPB6ClgB9kbYJiorl4QdBo7s+FlI2QCGiBU+/pr0XUu/7a2dndTmcLm1Qi+hGKRiKHFVZVfMBelkz67vvQ/9yvrSAM7N3CH7E+h8AL8czhG2WVlQU3DWowIA+o2qVI46LmEIvzdPnBHZNZNpAOQY5y6fMNVnWQ5544N5lE6QlRNkUN5M5CEefIt96XN3tzvWDpl6J6zDWBtCy0HfLGHTYC8gDQyCNP6/rkEnK5XIw4uWFhiDIHohkgL3lBo6NKTbpmCY9+kvnumIYrcxpt/XAfzdf26uDpMwGiKyCJa+SMMkYHlPVMxzXHLrWAtHmIcy2BbyO/Z1KDUvXiewZO+iLvDkyqmb8ZUK5LLMSNj2xFPRHg9VQWqCqUu88YyEv2bKE9FrUyzGbaZGcwHI2pioba7pbQUzLli0W10g4A0a2kWyTpFq6ifx/hF6kDsCg=\",\n \"TermUrl\": \"https://checkoutshopper-test.adyen.com/checkoutshopper/threeDS/return/H4sIAAAAAAAAAA3SSbZrQAAA0N28Wc7Rh0EGiSYqCEoQJk6hiNL3idX_f9dwLeWS1_QcMyJl3T_EJeqU0bDHwRNEnUrHByWBnPBTfhUP5A3fkIAPT2ZuYiyjbDHnFW0ZSuUc8OkA3n0z_kaXdW77XqVhg4I3tbrEPvHpnXx4OPS2I7iPIywe5Y4Y_jmAQlYqi3rB1lCwvF1pg44hKuxQVyLdzM8jjee3Wagm9Kp5sVjQ2LUtMArKKUXL7D6I6IhOEla9P3iHPq_2RxRQI9ANXbnj_UrPTgtKGfLdpJBHpH4L3C2yPforbiSThY-A2Zlrp9opuQMgXrvXtIUaeW_Ux9mw8fxyh5U1dCtVSf6sJ-3GB-9BiNC565YfTpuhZvJqM-ZNA2rEEl556gLc-qPXZTIyNk94djbdarMkSOoC5anz_QXC6sQL4kdkKgqw59h_oFi_v-UqC-QsBc1CBfYLdvp0DgJvlOLX83wVPO3bdNRcdfun8GOhTpkfHMVaNga0UDF1gkflx7UfBmUFfBorLUgR1GBqun28A0OfJZUlhKzbKwo55vZy9wSn-ciKi4h9fHRa2AIbNS9tV9Q8zeT8lJU9-JzIjMVfn_QeEAvlYeF6TXYVLl_Gm_TkLXtFhbJt4FtniZdVKmLf1qPTnU5Ym_aLYdKkrXmGTmqniWsSa_2rugWXE1qqvrugoUrQunz-hnmAuMAT7jJ8Mc5K_P5_CDrc_wUi8zdX5cXnsja68ZFpPDKVk3dT3UM8Ep87Sj3xOHlS7nVszLdKLf8Bk9S73NICAAA\"\n },\n \"method\": \"POST\",\n \"type\": \"redirect\"\n }\n}\n"}]}]}},"canceled":{"title":"canceled","description":"Previously authorized Payment has been Canceled.","value":{"id":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","status":"Canceled","createdAt":"2022-04-22T17:53:36.814Z","providerId":"e96aa893-4458-43c6-b334-179cf73f5dba","providerName":"adyen","providerReference":"adyen-6389361285","providerConfigId":"5cc8f271-0059-43a3-b339-27712c997e30","holderId":"785380c9-1015-453d-82ab-d3386e27c05e","amount":{"value":"22.40","currency":"EUR"},"instrumentId":"15b0069a-913b-4224-b05a-056e89611a51","instrumentTokenId":"38fa0ee2-3f6e-41c1-8298-7398b2a93bd3","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","instrument":{"id":"15b0069a-913b-4224-b05a-056e89611a51","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","description":"Personal card.","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe"},"meta":{"communityCode":"GAP","userKey":"9890124569"}},"transactionReference":"order-671934582","transactionElementReference":"wkf-24-64313","pspRedirectUrl":"","merchantReturnUrl":"http://merchant.com/redirect-from/def456","history":[{"id":"7314d8ea-ad96-4564-a954-8fc17584823b","createdAt":"2022-04-22T17:53:56.631Z","paymentId":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","type":"Authorize","providerReference":"adyen-auth-6389361285","amount":{"value":"22.40","currency":"EUR"},"result":"Success","responseCode":"Authorised","log":[{"id":"35773ce1-a5d6-41f4-a94f-3005ac12f8bf","createdAt":"2022-04-22T17:53:56.721Z","operationId":"7314d8ea-ad96-4564-a954-8fc17584823b","request":"{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"reference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"***REDACTED***\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"***REDACTED***\"\n },\n \"returnUrl\": \"http://payrails.com/redirect-from/def456\",\n \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n","response":"{\n \"additionalData\": {\n \"scaExemptionRequested\": \"transactionRiskAnalysis\"\n },\n \"pspReference\": \"adyen-6389361285\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"}]},{"id":"ec8922d9-597f-4f8a-a6c9-ac970d726eb9","createdAt":"2022-04-22T18:53:56.631Z","paymentId":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","type":"Cancel","providerReference":"adyen-cancel-6389361285","result":"Success","responseCode":"Cancelled","log":[{"id":"c1967b1e-5052-47ae-8930-8d7e522ef19c","createdAt":"2022-04-22T17:53:56.721Z","operationId":"ec8922d9-597f-4f8a-a6c9-ac970d726eb9","request":"{\n \"reference\": \"adyen-cancel-6389361285\",\n \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n","response":"{\n \"pspReference\": \"adyen-6389361285\",\n \"resultCode\": \"Cancelled\",\n \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"}]}]}},"captured":{"title":"captured","description":"Previously authorized Payment has been Captured.","value":{"id":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","status":"Captured","createdAt":"2022-04-22T17:53:36.814Z","providerId":"e96aa893-4458-43c6-b334-179cf73f5dba","providerName":"adyen","providerReference":"adyen-6389361285","providerConfigId":"5cc8f271-0059-43a3-b339-27712c997e30","holderId":"785380c9-1015-453d-82ab-d3386e27c05e","amount":{"value":"22.40","currency":"EUR"},"instrumentId":"15b0069a-913b-4224-b05a-056e89611a51","instrumentTokenId":"38fa0ee2-3f6e-41c1-8298-7398b2a93bd3","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","instrument":{"id":"15b0069a-913b-4224-b05a-056e89611a51","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","description":"Personal card.","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe"},"meta":{"communityCode":"GAP","userKey":"9890124569"}},"transactionReference":"order-671934582","transactionElementReference":"wkf-24-64313","pspRedirectUrl":"","merchantReturnUrl":"http://merchant.com/redirect-from/def456","history":[{"id":"7314d8ea-ad96-4564-a954-8fc17584823b","createdAt":"2022-04-22T17:53:56.631Z","paymentId":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","type":"Authorize","providerReference":"adyen-auth-6389361285","amount":{"value":"22.40","currency":"EUR"},"result":"Success","responseCode":"Authorised","log":[{"id":"35773ce1-a5d6-41f4-a94f-3005ac12f8bf","createdAt":"2022-04-22T17:53:56.721Z","operationId":"7314d8ea-ad96-4564-a954-8fc17584823b","request":"{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"reference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"***REDACTED***\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"***REDACTED***\"\n },\n \"returnUrl\": \"http://payrails.com/redirect-from/def456\",\n \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n","response":"{\n \"additionalData\": {\n \"scaExemptionRequested\": \"transactionRiskAnalysis\"\n },\n \"pspReference\": \"adyen-6389361285\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"}]},{"id":"ec8922d9-597f-4f8a-a6c9-ac970d726eb9","createdAt":"2022-04-22T18:53:56.631Z","paymentId":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","type":"Capture","providerReference":"adyen-capture-6389361285","amount":{"value":"22.40","currency":"EUR"},"result":"Success","responseCode":"Captured","log":[{"id":"c1967b1e-5052-47ae-8930-8d7e522ef19c","createdAt":"2022-04-22T18:53:56.631Z","operationId":"ec8922d9-597f-4f8a-a6c9-ac970d726eb9","request":"{\n \"reference\": \"adyen-capture-6389361285\",\n \"amount\": {\n \"value\": 2240,\n \"currency\": \"EUR\"\n },\n \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n","response":"{\n \"pspReference\": \"adyen-6389361285\",\n \"resultCode\": \"Captured\",\n \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"}]}]}},"refunded":{"title":"refunded","description":"Previously Captured Payment has been Refunded.","value":{"id":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","status":"Refunded","createdAt":"2022-04-22T17:53:36.814Z","providerId":"e96aa893-4458-43c6-b334-179cf73f5dba","providerName":"adyen","providerReference":"adyen-6389361285","providerConfigId":"5cc8f271-0059-43a3-b339-27712c997e30","holderId":"785380c9-1015-453d-82ab-d3386e27c05e","amount":{"value":"22.40","currency":"EUR"},"instrumentId":"15b0069a-913b-4224-b05a-056e89611a51","instrumentTokenId":"38fa0ee2-3f6e-41c1-8298-7398b2a93bd3","workspaceId":"7f9f1882-a103-408d-ac96-46a7021e537a","instrument":{"id":"15b0069a-913b-4224-b05a-056e89611a51","holderId":"788c7c09-a490-4603-915a-e2a957a6cca1","createdAt":"2022-04-22T17:53:36.814Z","updatedAt":"2022-04-22T17:53:36.814Z","paymentMethod":"card","description":"Personal card.","fingerprint":"739abff0-406a-4d32-8cfb-701e12be5848","status":"created","futureUsage":"CardOnFile","data":{"network":"visa","bin":"411111","suffix":"1111","expiryMonth":"10","expiryYear":"2026","holderName":"John Doe"},"meta":{"communityCode":"GAP","userKey":"9890124569"}},"transactionReference":"order-671934582","transactionElementReference":"wkf-24-64313","pspRedirectUrl":"","merchantReturnUrl":"http://merchant.com/redirect-from/def456","history":[{"id":"7314d8ea-ad96-4564-a954-8fc17584823b","createdAt":"2022-04-22T17:53:56.631Z","paymentId":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","type":"Authorize","providerReference":"adyen-auth-6389361285","amount":{"value":"22.40","currency":"EUR"},"result":"Success","responseCode":"Authorised","log":[{"id":"35773ce1-a5d6-41f4-a94f-3005ac12f8bf","createdAt":"2022-04-22T17:53:56.721Z","operationId":"7314d8ea-ad96-4564-a954-8fc17584823b","request":"{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"reference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"***REDACTED***\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"***REDACTED***\"\n },\n \"returnUrl\": \"http://payrails.com/redirect-from/def456\",\n \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n","response":"{\n \"additionalData\": {\n \"scaExemptionRequested\": \"transactionRiskAnalysis\"\n },\n \"pspReference\": \"adyen-6389361285\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2240\n },\n \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"}]},{"id":"ec8922d9-597f-4f8a-a6c9-ac970d726eb9","createdAt":"2022-04-22T18:53:56.631Z","paymentId":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","type":"Capture","providerReference":"adyen-capture-6389361285","amount":{"value":"22.40","currency":"EUR"},"result":"Success","responseCode":"Captured","log":[{"id":"c1967b1e-5052-47ae-8930-8d7e522ef19c","createdAt":"2022-04-22T17:53:56.721Z","operationId":"ec8922d9-597f-4f8a-a6c9-ac970d726eb9","request":"{\n \"reference\": \"adyen-capture-6389361285\",\n \"amount\": {\n \"value\": 2240,\n \"currency\": \"EUR\"\n },\n \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n","response":"{\n \"pspReference\": \"adyen-6389361285\",\n \"resultCode\": \"Captured\",\n \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"}]},{"id":"e0eca4bf-2722-4ed7-81aa-e434255b779b","createdAt":"2022-04-22T18:53:56.631Z","paymentId":"fe67fc45-ce47-4fc8-a283-22d03ae68b77","type":"Refund","providerReference":"adyen-refund-6389361285","amount":{"value":"22.40","currency":"EUR"},"result":"Success","responseCode":"Refunded","log":[{"id":"c1967b1e-5052-47ae-8930-8d7e522ef19c","createdAt":"2022-04-22T17:53:56.721Z","operationId":"e0eca4bf-2722-4ed7-81aa-e434255b779b","request":"{\n \"reference\": \"adyen-refund-6389361285\",\n \"amount\": {\n \"value\": 2240,\n \"currency\": \"EUR\"\n },\n \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n","response":"{\n \"pspReference\": \"adyen-6389361285\",\n \"resultCode\": \"Refunded\",\n \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"}]}]}}},"exampleType":"examples"}},"exampleType":"examples"},"27c297db-9bad-4919-abd1-3891644e2ad5":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.malformed","detail":"The request has malformed syntax","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestmalformed"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.malformed","detail":"The request has malformed syntax","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestmalformed"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"5987e8ca-9cd5-4cbb-a19f-e3494caec195":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.unauthorized","detail":"The request lacks necessary credentials to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestunauthorized"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.unauthorized","detail":"The request lacks necessary credentials to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestunauthorized"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"6fc803bd-8f73-4a8c-85b2-7a9e50bbe214":{"description":"Insufficient Scope.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"e7db22b3-914e-4975-928e-9edfb0885bea","code":"request.forbidden","detail":"The request credentials lack the required permissions to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestforbidden"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"e7db22b3-914e-4975-928e-9edfb0885bea","code":"request.forbidden","detail":"The request credentials lack the required permissions to perform the specified action","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestforbidden"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"3e9768ce-eba5-4759-8afc-2f84eab29723":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.not-found","detail":"The requested resource was not found","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestnot-found"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.not-found","detail":"The requested resource was not found","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestnot-found"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"6624d83d-3b1a-4191-b5ce-df12142aeaca":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","description":"Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure).","required":["id","code","detail"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster.","isRequired":true,"uniqueKey":"errors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes).","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description about the error, its cause, and resolution.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"docUrl":{"type":"string","description":"Link to the specific documentation about this particular `code`.","uniqueKey":"errors.items.[INDEX].docUrl","typeLabel":"string"},"reason":{"type":"object","additionalProperties":true,"description":"Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`.","uniqueKey":"errors.items.[INDEX].reason","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.rate-limit","detail":"Too many requests","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestrate-limit"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.rate-limit","detail":"Too many requests","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestrate-limit"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"490f75db-98b4-44a6-86f9-5a228ed6d1e0":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"You can use an OAuth2 JWT bearer token in the `Authorization` header of your API requests for supported endpoints: `Authorization: Bearer \u003cYOUR_JWT_HERE>`.\nThese tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint.\n","scopes":["payments:read"],"schemeName":"BearerToken"}}},"servers":{"2b65d804-16d0-4243-bffd-86c8d2fd3767":{"url":"https://api.eu.staging.payrails.io","description":"Payrails environment."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"You can use an OAuth2 JWT bearer token in the `Authorization` header of your API requests for supported endpoints: `Authorization: Bearer \u003cYOUR_JWT_HERE>`.\nThese tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint.\n","scopes":["payments:read"],"schemeName":"BearerToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"You can use an OAuth2 JWT bearer token in the `Authorization` header of your API requests for supported endpoints: `Authorization: Bearer \u003cYOUR_JWT_HERE>`.\nThese tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerToken","name":"Authorization"}],"title":"BearerToken"}]},"originalFileLocation":"https://cdn.payrails.io/docs/api/openapi.min.json"},"subdomain":"payrails-42074109","siteName":"Payrails Docs","title":"Get payment by ID - Payrails Docs","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"reference/getpayment.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve a payment by ID with its status, captured and refunded amounts, and provider details, and optionally the instrument and payment token.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Payrails Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get payment by ID - Payrails Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a payment by ID with its status, captured and refunded amounts, and provider details, and optionally the instrument and payment token.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payrails Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payrails.com/reference/getpayment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://payrails-42074109.mintlify.site/_mintlify/api/og/v2?division=Payments\u0026amp;title=Get+payment+by+ID\u0026amp;description=Retrieve+a+payment+by+ID+with+its+status%2C+captured+and+refunded+amounts%2C+and+provider+details%2C+and+optionally+the+instrument+and+payment+token.\u0026amp;theme=fc36d2d43704e46c9451c8d9\u0026amp;signature=c27aa931cea31da25262a44ab1e41c37690f42555c3e1fca24a2aceea55af7e3\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get payment by ID - Payrails Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a payment by ID with its status, captured and refunded amounts, and provider details, and optionally the instrument and payment token.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://payrails-42074109.mintlify.site/_mintlify/api/og/v2?division=Payments\u0026amp;title=Get+payment+by+ID\u0026amp;description=Retrieve+a+payment+by+ID+with+its+status%2C+captured+and+refunded+amounts%2C+and+provider+details%2C+and+optionally+the+instrument+and+payment+token.\u0026amp;theme=fc36d2d43704e46c9451c8d9\u0026amp;signature=c27aa931cea31da25262a44ab1e41c37690f42555c3e1fca24a2aceea55af7e3\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/payrails-42074109/xPEGo5yZy52JZSmG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Payrails Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#D63D00\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"msvalidate.01\" content=\"7723ABF900EAD08F0500790E9BFC62E7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.payrails.com/reference/getpayment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/getpayment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.payrails.com#organization\",\"name\":\"Payrails\",\"legalName\":\"Payrails GmbH\",\"url\":\"https://www.payrails.com/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://www.payrails.com/payrails-logo.svg\"},\"sameAs\":[\"https://www.linkedin.com/company/payrails/\",\"https://www.crunchbase.com/organization/payrails\",\"https://www.wikidata.org/wiki/Q137211152\",\"https://x.com/Payrails_com\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.payrails.com#website\",\"name\":\"Payrails Docs\",\"url\":\"https://docs.payrails.com\",\"publisher\":{\"@id\":\"https://www.payrails.com#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.payrails.com/reference/getpayment#webpage\",\"url\":\"https://docs.payrails.com/reference/getpayment\",\"name\":\"Get payment by ID\",\"description\":\"Retrieve a payment by ID with its status, captured and refunded amounts, and provider details, and optionally the instrument and payment token.\",\"isPartOf\":{\"@id\":\"https://docs.payrails.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.payrails.com/reference/getpayment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.payrails.com/reference/getpayment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payment\",\"item\":\"https://docs.payrails.com/reference/listpayments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payments\",\"item\":\"https://docs.payrails.com/reference/listpayments\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get payment by ID\",\"item\":\"https://docs.payrails.com/reference/getpayment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.payrails.com/reference/getpayment#apireference\",\"headline\":\"Get payment by ID\",\"name\":\"Get payment by ID\",\"description\":\"Retrieve a payment by ID with its status, captured and refunded amounts, and provider details, and optionally the instrument and payment token.\",\"url\":\"https://docs.payrails.com/reference/getpayment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.payrails.com/reference/getpayment#webpage\"},\"publisher\":{\"@id\":\"https://www.payrails.com#organization\"},\"isPartOf\":{\"@id\":\"https://docs.payrails.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Payrails Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Payrails\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/getpayment.md","siteName":"Payrails Docs","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/explore-payrails"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/docs/integrations"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/docs/sdks"}]},{"tab":"API Reference","groups":[{"group":"Payrails API Reference","pages":[{"title":"API reference","sidebarTitle":"Overview","href":"/reference"},{"group":"Schemas","pages":[{"title":"Meta","href":"/reference/meta"},{"title":"Funds Transfer","href":"/reference/fundstransfer"},{"group":"Workflow Schemas","expanded":false,"pages":[{"title":"Create Execution Response","href":"/reference/createexecutionresponse"},{"title":"Enrollment Payment Composition","href":"/reference/enrollmentpaymentcomposition"},{"title":"Payment Composition","href":"/reference/paymentcomposition"},{"title":"Payout Composition","href":"/reference/payoutcomposition"},{"title":"Pending Payment Composition","href":"/reference/pendingpaymentcomposition"},{"title":"Resolved Rulesets","href":"/reference/resolvedrulesets"},{"title":"Rule Evaluation","href":"/reference/ruleevaluation"},{"title":"Step Next Actions","href":"/reference/workflowstepnextactions"}]}]},{"group":"SDK Reference","expanded":false,"pages":[{"group":"Web SDK","pages":[{"title":"Web SDK Event API Reference","sidebarTitle":"Events","href":"/docs/sdks/web/references/event-api-reference"},{"title":"Web SDK Appearance API Reference","sidebarTitle":"Appearance","href":"/docs/sdks/web/references/appearance-api-reference"},{"title":"Web SDK Payrails Class Reference","sidebarTitle":"Payrails class","href":"/docs/sdks/web/references/payrails-api-reference"}]},{"title":"iOS SDK API Reference","sidebarTitle":"iOS SDK","href":"/docs/sdks/ios/sdk-api-reference"},{"title":"Android SDK API Reference","sidebarTitle":"Android SDK","href":"/docs/sdks/android/api-reference"},{"title":"React Native SDK API Reference","sidebarTitle":"React Native SDK","href":"/docs/sdks/react-native/api-references"}]}]},{"group":"Get started","pages":[{"group":"Authentication","pages":[{"title":"Request an access token","deprecated":null,"version":null,"sidebarTitle":"Request an access token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /auth/token/{clientId}","href":"/reference/getoauthtoken"},{"title":"Request a Vault access token","deprecated":null,"version":null,"sidebarTitle":"Request a Vault access token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/auth","href":"/reference/getvaultaccesstoken"}]},{"group":"Client","pages":[{"title":"Initialize a client SDK","deprecated":null,"version":null,"sidebarTitle":"Initialize a client SDK","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/client/init","href":"/reference/clientinit"}]},{"group":"SSO Connections","pages":[{"title":"List SSO connections","deprecated":null,"version":null,"sidebarTitle":"List SSO connections","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /auth/sso/connections","href":"/reference/listssoconnections"},{"title":"Create SSO connection","deprecated":null,"version":null,"sidebarTitle":"Create SSO connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /auth/sso/connections","href":"/reference/createssoconnection"},{"title":"Get SSO connection","deprecated":null,"version":null,"sidebarTitle":"Get SSO connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /auth/sso/connections/{connectionId}","href":"/reference/getssoconnectionbyid"},{"title":"Update SSO connection","deprecated":null,"version":null,"sidebarTitle":"Update SSO connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /auth/sso/connections/{connectionId}","href":"/reference/patchssoconnection"},{"title":"Get SAML IdP configuration values","deprecated":null,"version":null,"sidebarTitle":"Get SAML IdP configuration values","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /auth/sso/connections/saml-configs","href":"/reference/listsamlconnectionconfigs"}]}]},{"group":"Workflow","pages":[{"group":"Workflows","pages":[{"title":"Search \u0026 list workflow configurations","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list workflow configurations","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}","href":"/reference/listworkflowconfigurations"},{"title":"Create a workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Create a workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}","href":"/reference/createworkflowconfiguration"},{"title":"Get a workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Get a workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/versions/{workflowVersion}","href":"/reference/getworkflowconfigurationversion"},{"title":"Updates a workflow configuration version","deprecated":null,"version":null,"sidebarTitle":"Updates a workflow configuration version","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /merchant/workflows/{workflowCode}/versions/{workflowVersion}","href":"/reference/patchworkflowconfigurationversion"},{"title":"Get the default workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Get the default workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/versions/default","href":"/reference/getdefaultworkflowconfigurationversion"},{"title":"Update the default workflow configuration","deprecated":null,"version":null,"sidebarTitle":"Update the default workflow configuration","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /merchant/workflows/{workflowCode}/versions/default","href":"/reference/setdefaultworkflowconfigurationversion"}]},{"group":"Executions","pages":[{"title":"Search \u0026 list executions","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list executions","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions","href":"/reference/listexecutions"},{"title":"Create an execution","deprecated":null,"version":null,"sidebarTitle":"Create an execution","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions","href":"/reference/createexecution"},{"title":"Get an execution by ID","deprecated":null,"version":null,"sidebarTitle":"Get an execution by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}","href":"/reference/getexecution"}]},{"group":"Actions","pages":[{"title":"Lookup payment options","deprecated":null,"version":null,"sidebarTitle":"Lookup payment options","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/lookup","href":"/reference/lookupaction"},{"title":"Start a payment session","deprecated":null,"version":null,"sidebarTitle":"Start a payment session","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/startPaymentSession","href":"/reference/startpaymentsessionaction"},{"title":"Authorize a payment","deprecated":null,"version":null,"sidebarTitle":"Authorize a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/authorize","href":"/reference/authorizeaction"},{"title":"Confirm a payment","deprecated":null,"version":null,"sidebarTitle":"Confirm a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/confirm","href":"/reference/confirmaction"},{"title":"Cancel a payment","deprecated":null,"version":null,"sidebarTitle":"Cancel a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/cancel","href":"/reference/cancelaction"},{"title":"Capture a payment","deprecated":null,"version":null,"sidebarTitle":"Capture a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/capture","href":"/reference/captureaction"},{"title":"Refund a payment","deprecated":null,"version":null,"sidebarTitle":"Refund a payment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/refund","href":"/reference/refundaction"},{"title":"Create a payout","deprecated":null,"version":null,"sidebarTitle":"Create a payout","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/payout","href":"/reference/payoutaction"},{"title":"Search \u0026 list events","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}/history","href":"/reference/getworkflowhistory"},{"title":"List actions of an execution","deprecated":null,"version":null,"sidebarTitle":"List actions of an execution","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workflows/{workflowCode}/executions/{executionId}/actions","href":"/reference/getworkflowactions"},{"title":"Update fraud order status","deprecated":null,"version":null,"sidebarTitle":"Update fraud order status","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions/{executionId}/orderUpdate","href":"/reference/fraudupdateaction"},{"title":"Search \u0026 list actions","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list actions","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/actions","href":"/reference/listactions"},{"title":"Get an action by ID","deprecated":null,"version":null,"sidebarTitle":"Get an action by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/actions/{actionId}","href":"/reference/getaction"}]}]},{"group":"Payment","pages":[{"group":"Payments","pages":[{"title":"Search \u0026 list payments","description":"List payments, filtering by status, merchant reference, provider, holder, payment method, or instrument details such as BIN, card network, and issuer.","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list payments","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments","href":"/reference/listpayments"},{"title":"Get payment by ID","deprecated":null,"version":null,"sidebarTitle":"Get payment by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}","href":"/reference/getpayment"},{"title":"Get Payment Operations by Payment ID","description":"List a payment's operations, such as authorize, capture, and refund, with their results and the payment status after each, optionally including logs.","deprecated":null,"version":null,"sidebarTitle":"Get Payment Operations by Payment ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}/operations","href":"/reference/getpaymentoperations"},{"title":"Get Payment Operation Logs by Payment Operation ID","deprecated":null,"version":null,"sidebarTitle":"Get Payment Operation Logs by Payment Operation ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}/operations/{paymentOperationId}/logs","href":"/reference/getpaymentoperationlogs"}]},{"group":"Instruments","pages":[{"title":"Search \u0026 list instruments","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list instruments","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments","href":"/reference/listinstruments"},{"title":"Create an instrument","deprecated":null,"version":null,"sidebarTitle":"Create an instrument","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments","href":"/reference/createinstrument"},{"title":"Get an instrument by ID","deprecated":null,"version":null,"sidebarTitle":"Get an instrument by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments/{instrumentId}","href":"/reference/getinstrument"},{"title":"Delete an instrument","deprecated":null,"version":null,"sidebarTitle":"Delete an instrument","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /payment/instruments/{instrumentId}","href":"/reference/deleteinstrument"},{"title":"Update an instrument","deprecated":null,"version":null,"sidebarTitle":"Update an instrument","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /payment/instruments/{instrumentId}","href":"/reference/updateinstrument"},{"title":"Provision a Network Token","deprecated":null,"version":null,"sidebarTitle":"Provision a Network Token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments/{instrumentId}/provisionNetworkToken","href":"/reference/provisionnetworktokenpublic"},{"title":"Generate cryptogram for a Network Token","deprecated":null,"version":null,"sidebarTitle":"Generate cryptogram for a Network Token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments/{instrumentId}/generateCryptogram","href":"/reference/generatecryptogram"}]},{"group":"Instrument Tokens","pages":[{"title":"Search \u0026 list tokens","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list tokens","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments/{instrumentId}/tokens","href":"/reference/listtokens"},{"title":"Create a token","deprecated":null,"version":null,"sidebarTitle":"Create a token","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/instruments/{instrumentId}/tokens","href":"/reference/createtoken"},{"title":"Get a token by ID","deprecated":null,"version":null,"sidebarTitle":"Get a token by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments/{instrumentId}/tokens/{tokenId}","href":"/reference/gettoken"},{"title":"Delete a token by ID","deprecated":null,"version":null,"sidebarTitle":"Delete a token by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /payment/instruments/{instrumentId}/tokens/{tokenId}","href":"/reference/deletetoken"},{"title":"Get a token by reference","deprecated":null,"version":null,"sidebarTitle":"Get a token by reference","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}/tokens/{tokenReference}","href":"/reference/gettokenfromprovider"},{"title":"Delete a token by reference","deprecated":null,"version":null,"sidebarTitle":"Delete a token by reference","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /payment/providers/{providerId}/tokens/{tokenReference}","href":"/reference/deletetokenfromprovider"}]},{"group":"BIN Lookup","pages":[{"title":"Get issuer info by BIN","deprecated":null,"version":null,"sidebarTitle":"Get issuer info by BIN","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/binLookup/{bin}","href":"/reference/getbinlookup"}]},{"group":"API Logs","pages":[{"title":"Search \u0026 list API Logs","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list API Logs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/api/logs","href":"/reference/apilogs"},{"title":"Get an API Log event by ID","deprecated":null,"version":null,"sidebarTitle":"Get an API Log event by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/api/logs/{apiLogEventId}","href":"/reference/getapilogevent"}]},{"group":"Fraud Checks","pages":[{"title":"Search \u0026 list Fraud checks","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Fraud checks","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds","href":"/reference/listfraudchecks"},{"title":"Get Fraud check by ID","deprecated":null,"version":null,"sidebarTitle":"Get Fraud check by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds/{fraudId}","href":"/reference/getfraud"},{"title":"Get Fraud Operations by Fraud ID","deprecated":null,"version":null,"sidebarTitle":"Get Fraud Operations by Fraud ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds/{fraudId}/operations","href":"/reference/getfraudoperations"},{"title":"Get Fraud Operation Logs by Fraud Operation ID","deprecated":null,"version":null,"sidebarTitle":"Get Fraud Operation Logs by Fraud Operation ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/frauds/{fraudId}/operations/{fraudOperationId}/logs","href":"/reference/getfraudoperationlogs"}]},{"group":"3D Secure","pages":[{"title":"Search \u0026 list ThreeDS entities","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list ThreeDS entities","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds","href":"/reference/listthreeds"},{"title":"Get ThreeDS authentication by ID","deprecated":null,"version":null,"sidebarTitle":"Get ThreeDS authentication by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds/{threeDSId}","href":"/reference/getthreeds"},{"title":"Get ThreeDS Operations by ThreeDS ID","deprecated":null,"version":null,"sidebarTitle":"Get ThreeDS Operations by ThreeDS ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds/{threeDSId}/operations","href":"/reference/getthreedsoperations"},{"title":"Get ThreeDS Operation Logs by ThreeDS Operation ID","deprecated":null,"version":null,"sidebarTitle":"Get ThreeDS Operation Logs by ThreeDS Operation ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/threeds/{threeDSId}/operation/{threeDSOperationId}/logs","href":"/reference/getthreedsoperationlogs"}]}]},{"group":"Provider","pages":[{"group":"Providers","pages":[{"title":"Search \u0026 list providers","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list providers","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers","href":"/reference/listproviders"},{"title":"Get provider by ID","deprecated":null,"version":null,"sidebarTitle":"Get provider by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}","href":"/reference/getprovider"}]},{"group":"Provider Configs","pages":[{"title":"List active provider configs","deprecated":null,"version":null,"sidebarTitle":"List active provider configs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/configs","href":"/reference/listactiveproviderconfigs"},{"title":"List Provider Configs by Provider","deprecated":null,"version":null,"sidebarTitle":"List Provider Configs by Provider","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}/configs","href":"/reference/listproviderconfigs"},{"title":"Create a provider config","deprecated":null,"version":null,"sidebarTitle":"Create a provider config","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/configs","href":"/reference/createproviderconfig"},{"title":"Create a provider config with authenticated onboarding","deprecated":null,"version":null,"sidebarTitle":"Create a provider config with authenticated onboarding","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/configs/authenticated","href":"/reference/createauthenticatedproviderconfig"},{"title":"Provider config by ID","deprecated":null,"version":null,"sidebarTitle":"Provider config by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/providers/{providerId}/configs/{providerConfigId}","href":"/reference/providerconfiggetbyid"},{"title":"Update a provider config","deprecated":null,"version":null,"sidebarTitle":"Update a provider config","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /payment/providers/{providerId}/configs/{providerConfigId}","href":"/reference/updateproviderconfig"},{"title":"Update a provider config status","deprecated":null,"version":null,"sidebarTitle":"Update a provider config status","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /payment/providers/{providerId}/configs/{providerConfigId}","href":"/reference/patchproviderconfig"},{"title":"Update a provider config with authenticated onboarding","deprecated":null,"version":null,"sidebarTitle":"Update a provider config with authenticated onboarding","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /payment/providers/{providerId}/configs/{providerConfigId}/authenticated","href":"/reference/updateauthenticatedproviderconfig"},{"title":"Create a provider config onboarding URL","deprecated":null,"version":null,"sidebarTitle":"Create a provider config onboarding URL","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/configs/{providerConfigId}/onboarding-url","href":"/reference/createproviderconfigonboardingurl"}]}]},{"group":"Merchant","pages":[{"group":"Rulesets","pages":[{"title":"List Rulesets","deprecated":null,"version":null,"sidebarTitle":"List Rulesets","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/rulesets","href":"/reference/listrulesets"},{"title":"Create a new Ruleset","deprecated":null,"version":null,"sidebarTitle":"Create a new Ruleset","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/rulesets","href":"/reference/createruleset"},{"title":"Update a Ruleset","deprecated":null,"version":null,"sidebarTitle":"Update a Ruleset","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /merchant/rulesets/{rulesetId}","href":"/reference/updateruleset"},{"title":"Get a Ruleset","deprecated":null,"version":null,"sidebarTitle":"Get a Ruleset","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/rulesets/{rulesetId}/versions/{version}","href":"/reference/getruleset"}]},{"group":"Holders","pages":[{"title":"Search \u0026 list holders","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list holders","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/holders","href":"/reference/listholders"},{"title":"Create a holder","deprecated":null,"version":null,"sidebarTitle":"Create a holder","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/holders","href":"/reference/createholder"},{"title":"Get a holder by ID","deprecated":null,"version":null,"sidebarTitle":"Get a holder by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/holders/{holderId}","href":"/reference/getholder"}]},{"group":"Workspaces","pages":[{"title":"Fetch a list of workspaces","deprecated":null,"version":null,"sidebarTitle":"Fetch a list of workspaces","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workspaces","href":"/reference/getallworkspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"sidebarTitle":"Create a workspace","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workspaces","href":"/reference/createworkspace"},{"title":"Create workspaces","deprecated":null,"version":null,"sidebarTitle":"Create workspaces","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workspaces/bulk-create","href":"/reference/createworkspaces"},{"title":"Get a workspace by ID","deprecated":null,"version":null,"sidebarTitle":"Get a workspace by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/workspaces/{workspaceId}","href":"/reference/getworkspace"}]},{"group":"Drop-in Links","pages":[{"title":"List drop-in links","deprecated":null,"version":null,"sidebarTitle":"List drop-in links","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/dropInLinks","href":"/reference/listdropinlinks"},{"title":"Create a drop-in link","deprecated":null,"version":null,"sidebarTitle":"Create a drop-in link","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/dropInLinks","href":"/reference/createdropinlink"},{"title":"Get a drop-in link","deprecated":null,"version":null,"sidebarTitle":"Get a drop-in link","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/dropInLinks/{dropInLinkId}","href":"/reference/getdropinlink"},{"title":"Delete a drop-in link","deprecated":null,"version":null,"sidebarTitle":"Delete a drop-in link","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /merchant/dropInLinks/{dropInLinkId}","href":"/reference/deletedropinlink"}]},{"group":"Apple Pay","pages":[{"title":"List Apple Pay web domains","deprecated":null,"version":null,"sidebarTitle":"List Apple Pay web domains","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /merchant/applepay/web/domains","href":"/reference/listapplepaywebdomains"},{"title":"Register an Apple Pay web domain","deprecated":null,"version":null,"sidebarTitle":"Register an Apple Pay web domain","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/applepay/web/domains","href":"/reference/registerapplepaywebdomain"}]}]},{"group":"Vault","pages":[{"group":"Vault Instant Proxy","pages":[{"title":"Execute an instant proxy request","deprecated":null,"version":null,"sidebarTitle":"Execute an instant proxy request","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /payment/providers/{providerId}/proxy","href":"/reference/vaultproxy"}]},{"group":"Vault Proxy Connections","pages":[{"title":"Filter \u0026 list connections","deprecated":null,"version":null,"sidebarTitle":"Filter \u0026 list connections","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections","href":"/reference/listconnections"},{"title":"Create a connection","deprecated":null,"version":null,"sidebarTitle":"Create a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/connections","href":"/reference/createvaultconnections"},{"title":"Invoke an outbound proxy connection","deprecated":null,"version":null,"sidebarTitle":"Invoke an outbound proxy connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/connections/{connectionId}/proxy","href":"/reference/outboundconnectioninvocation"},{"title":"Get connection details","deprecated":null,"version":null,"sidebarTitle":"Get connection details","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections/{connectionId}","href":"/reference/getconnection"},{"title":"Delete a connection","deprecated":null,"version":null,"sidebarTitle":"Delete a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/connections/{connectionId}","href":"/reference/deleteconnection"},{"title":"Update connection details","deprecated":null,"version":null,"sidebarTitle":"Update connection details","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /token/connections/{connectionId}","href":"/reference/updateconnection"},{"title":"List connection versions for connection","deprecated":null,"version":null,"sidebarTitle":"List connection versions for connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections/{connectionId}/versions","href":"/reference/listconnectionversions"},{"title":"Create a new version of a connection","deprecated":null,"version":null,"sidebarTitle":"Create a new version of a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/connections/{connectionId}/versions","href":"/reference/createvaultconnectionversions"},{"title":"Get connection version details","deprecated":null,"version":null,"sidebarTitle":"Get connection version details","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/connections/{connectionId}/versions/{connectionVersionId}","href":"/reference/connectionversiondetail"},{"title":"Set live version of a connection","deprecated":null,"version":null,"sidebarTitle":"Set live version of a connection","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /token/connections/{connectionId}/versions/live","href":"/reference/setliveversion"}]},{"group":"Vault Records and Aliases","pages":[{"title":"Tokenize records","deprecated":null,"version":null,"sidebarTitle":"Tokenize records","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /records/tokenize","href":"/reference/tokenizerecords"},{"title":"Detokenize records and aliases","deprecated":null,"version":null,"sidebarTitle":"Detokenize records and aliases","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /records/detokenize","href":"/reference/detokenizerecords"},{"title":"Get field details by alias","deprecated":null,"version":null,"sidebarTitle":"Get field details by alias","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records/fields/{alias}","href":"/reference/fieldbyalias"},{"title":"Delete field by alias","deprecated":null,"version":null,"sidebarTitle":"Delete field by alias","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records/fields/{alias}","href":"/reference/deletefieldbyalias"},{"title":"Get field details by alias list","deprecated":null,"version":null,"sidebarTitle":"Get field details by alias list","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records/fields","href":"/reference/fieldsinfobyaliases"},{"title":"Get record and its fields by ID","deprecated":null,"version":null,"sidebarTitle":"Get record and its fields by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records/{recordId}","href":"/reference/getrecord"},{"title":"Delete record by ID","deprecated":null,"version":null,"sidebarTitle":"Delete record by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records/{recordId}","href":"/reference/deleterecord"},{"title":"Delete field by record ID and type","deprecated":null,"version":null,"sidebarTitle":"Delete field by record ID and type","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records/{recordId}/fields/{fieldType}","href":"/reference/deletefieldbyrecordidandtype"},{"title":"Get record and its fields by alias","deprecated":null,"version":null,"sidebarTitle":"Get record and its fields by alias","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/records","href":"/reference/getrecordbyalias"},{"title":"Delete a record by the alias of one of its fields","deprecated":null,"version":null,"sidebarTitle":"Delete a record by the alias of one of its fields","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /token/records","href":"/reference/deleterecordbyalias"},{"title":"Get record and aliases for a given instrumentId.","deprecated":null,"version":null,"sidebarTitle":"Get record and aliases for a given instrumentId.","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /token/instruments/{instrumentId}/records","href":"/reference/recordsforinstrument"}]},{"group":"Vault Display SDK","pages":[{"title":"Initialize a Vault Client SDK","deprecated":null,"version":null,"sidebarTitle":"Initialize a Vault Client SDK","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /token/client/init","href":"/reference/vaultclientinit"}]},{"group":"Vault Public Encryption","pages":[{"title":"Get a public encryption key for tokenization","deprecated":null,"version":null,"sidebarTitle":"Get a public encryption key for tokenization","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /payment/vault/info","href":"/reference/vaultpublicinfo"}]}]},{"group":"Analytics","pages":[{"group":"Files","pages":[{"title":"Get file by ID.","deprecated":null,"version":null,"sidebarTitle":"Get file by ID.","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/files/{fileId}","href":"/reference/getfilebyid"},{"title":"Get a URL for file upload.","deprecated":null,"version":null,"sidebarTitle":"Get a URL for file upload.","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /analytics/files/upload","href":"/reference/fileupload"}]}]},{"group":"Reporting","pages":[{"group":"Reports","pages":[{"title":"Search \u0026 list reports","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list reports","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reports","href":"/reference/getreports"},{"title":"Get a report by ID","deprecated":null,"version":null,"sidebarTitle":"Get a report by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reports/{reportId}","href":"/reference/getreport"}]},{"group":"Report Runs","pages":[{"title":"Search \u0026 list report runs","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list report runs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reportRuns","href":"/reference/listreportruns"},{"title":"Create a report run","deprecated":null,"version":null,"sidebarTitle":"Create a report run","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /analytics/reportRuns","href":"/reference/createreportrun"},{"title":"Get a report run by ID","deprecated":null,"version":null,"sidebarTitle":"Get a report run by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /analytics/reportRuns/{reportRunId}","href":"/reference/getreportrun"}]}]},{"group":"Reconciliation","pages":[{"group":"Reconciliation Records","pages":[{"title":"Bulk manually reconcile records","deprecated":null,"version":null,"sidebarTitle":"Bulk manually reconcile records","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /reconciliation/records/reconcile","href":"/reference/bulkmanualreconcilerecords"}]}]},{"group":"Dispute","pages":[{"group":"Disputes","pages":[{"title":"Search \u0026 list Disputes","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Disputes","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes","href":"/reference/listdisputes"},{"title":"Bulk Replace Dispute Tags by Type","deprecated":null,"version":null,"sidebarTitle":"Bulk Replace Dispute Tags by Type","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /dispute/disputes/tags-bulk","href":"/reference/bulkreplacedisputetagsbytype"},{"title":"Bulk Attach Tags to Disputes","deprecated":null,"version":null,"sidebarTitle":"Bulk Attach Tags to Disputes","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/tags-bulk","href":"/reference/bulkattachdisputetags"},{"title":"List dispute service runs","deprecated":null,"version":null,"sidebarTitle":"List dispute service runs","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/runs","href":"/reference/listdisputeruns"},{"title":"Get a dispute service run by ID","deprecated":null,"version":null,"sidebarTitle":"Get a dispute service run by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/runs/{runId}","href":"/reference/getdisputerun"},{"title":"List Dispute Alert Enrollments","deprecated":null,"version":null,"sidebarTitle":"List Dispute Alert Enrollments","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alert-enrollments","href":"/reference/listdisputealertenrollments"},{"title":"Enroll Descriptors for Dispute Alerts","deprecated":null,"version":null,"sidebarTitle":"Enroll Descriptors for Dispute Alerts","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alert-enrollments","href":"/reference/enrolldisputealert"},{"title":"List Enrollment Descriptors","deprecated":null,"version":null,"sidebarTitle":"List Enrollment Descriptors","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alert-enrollments/{enrollmentId}/descriptors","href":"/reference/listenrollmentdescriptors"},{"title":"Add Descriptors to Enrollment","deprecated":null,"version":null,"sidebarTitle":"Add Descriptors to Enrollment","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alert-enrollments/{enrollmentId}/descriptors","href":"/reference/adddescriptorstoenrollment"},{"title":"Unenroll a Descriptor","deprecated":null,"version":null,"sidebarTitle":"Unenroll a Descriptor","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alert-enrollments/{enrollmentId}/descriptors/{descriptorId}/unenroll","href":"/reference/unenrollenrollmentdescriptor"},{"title":"List Enrollment Events","deprecated":null,"version":null,"sidebarTitle":"List Enrollment Events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alert-enrollments/{enrollmentId}/events","href":"/reference/listenrollmentevents"},{"title":"Search \u0026 list Dispute Alerts","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Dispute Alerts","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alerts","href":"/reference/listdisputealerts"},{"title":"Get Dispute Alert by ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute Alert by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alerts/{alertId}","href":"/reference/getdisputealert"},{"title":"Action a Dispute Alert","deprecated":null,"version":null,"sidebarTitle":"Action a Dispute Alert","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alerts/{alertId}/action","href":"/reference/actiondisputealert"},{"title":"Manually Match a Payment to a Dispute Alert","deprecated":null,"version":null,"sidebarTitle":"Manually Match a Payment to a Dispute Alert","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alerts/{alertId}/match","href":"/reference/matchdisputealertpayment"},{"title":"Refund a Dispute Alert","deprecated":null,"version":null,"sidebarTitle":"Refund a Dispute Alert","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/alerts/{alertId}/refund","href":"/reference/refunddisputealert"},{"title":"List Dispute Alert Events","deprecated":null,"version":null,"sidebarTitle":"List Dispute Alert Events","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/alerts/{alertId}/events","href":"/reference/listdisputealertevents"},{"title":"List evidence library documents","deprecated":null,"version":null,"sidebarTitle":"List evidence library documents","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents","href":"/reference/listevidencedocuments"},{"title":"Add an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Add an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents","href":"/reference/createevidencedocument"},{"title":"Get an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Get an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents/{documentId}","href":"/reference/getevidencedocument"},{"title":"Update an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Update an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /dispute/disputes/evidence-documents/{documentId}","href":"/reference/renameevidencedocument"},{"title":"Add a version to an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Add a version to an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/versions","href":"/reference/addevidencedocumentversion"},{"title":"Get a version of an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Get a version of an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents/{documentId}/versions/{version}","href":"/reference/getevidencedocumentversion"},{"title":"List the disputes that use an evidence library document","deprecated":null,"version":null,"sidebarTitle":"List the disputes that use an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-documents/{documentId}/usages","href":"/reference/listevidencedocumentusages"},{"title":"Archive an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Archive an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/archive","href":"/reference/archiveevidencedocument"},{"title":"Restore an archived evidence library document","deprecated":null,"version":null,"sidebarTitle":"Restore an archived evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/restore","href":"/reference/restoreevidencedocument"},{"title":"Archive one version of an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Archive one version of an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/versions/{version}/archive","href":"/reference/archiveevidencedocumentversion"},{"title":"Restore one archived version of an evidence library document","deprecated":null,"version":null,"sidebarTitle":"Restore one archived version of an evidence library document","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/evidence-documents/{documentId}/versions/{version}/restore","href":"/reference/restoreevidencedocumentversion"},{"title":"List evidence templates","deprecated":null,"version":null,"sidebarTitle":"List evidence templates","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/evidence-templates","href":"/reference/listevidencetemplates"},{"title":"Get Dispute by ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}","href":"/reference/getdispute"},{"title":"Defend a Dispute","deprecated":null,"version":null,"sidebarTitle":"Defend a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/defend","href":"/reference/defenddispute"},{"title":"Accept a Dispute","deprecated":null,"version":null,"sidebarTitle":"Accept a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/accept","href":"/reference/acceptdispute"},{"title":"Get Dispute Activities by Dispute ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute Activities by Dispute ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/activities","href":"/reference/getdisputeactivities"},{"title":"Get Dispute Documents by Dispute ID","deprecated":null,"version":null,"sidebarTitle":"Get Dispute Documents by Dispute ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/documents","href":"/reference/getdisputedocuments"},{"title":"Search \u0026 list Evidences","deprecated":null,"version":null,"sidebarTitle":"Search \u0026 list Evidences","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/evidences","href":"/reference/listdisputeevidences"},{"title":"Upload evidence files","deprecated":null,"version":null,"sidebarTitle":"Upload evidence files","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences","href":"/reference/uploaddisputeevidence"},{"title":"Classify an evidence file","deprecated":null,"version":null,"sidebarTitle":"Classify an evidence file","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/{evidenceId}/classify","href":"/reference/classifydisputeevidence"},{"title":"Attach an evidence library document to a dispute","deprecated":null,"version":null,"sidebarTitle":"Attach an evidence library document to a dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/library","href":"/reference/attachevidencedocumenttodispute"},{"title":"Submit evidence files","deprecated":null,"version":null,"sidebarTitle":"Submit evidence files","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/submit","href":"/reference/submitdisputeevidence"},{"title":"Submit representment plan evidences","deprecated":null,"version":null,"sidebarTitle":"Submit representment plan evidences","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/submit-plan","href":"/reference/submitdisputerepresentmentplanevidences"},{"title":"Generate representment plan","deprecated":null,"version":null,"sidebarTitle":"Generate representment plan","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/generate-plan","href":"/reference/generatedisputerepresentmentplan"},{"title":"Regenerate representment plan","deprecated":null,"version":null,"sidebarTitle":"Regenerate representment plan","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/regenerate-plan","href":"/reference/regeneratedisputerepresentmentplan"},{"title":"Edit representment sections","deprecated":null,"version":null,"sidebarTitle":"Edit representment sections","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /dispute/disputes/{disputeId}/evidences/representment-sections","href":"/reference/editdisputerepresentmentsections"},{"title":"Rewrite representment text","deprecated":null,"version":null,"sidebarTitle":"Rewrite representment text","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/representment-sections/rewrite","href":"/reference/rewritedisputerepresentmenttext"},{"title":"Suggest representment section text","deprecated":null,"version":null,"sidebarTitle":"Suggest representment section text","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/representment-sections/{sectionId}/suggestion","href":"/reference/suggestdisputerepresentmentsection"},{"title":"Generate representment PDF","deprecated":null,"version":null,"sidebarTitle":"Generate representment PDF","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/evidences/generate-representment","href":"/reference/generatedisputerepresentmentpdf"},{"title":"Download the representment evidence bundle","deprecated":null,"version":null,"sidebarTitle":"Download the representment evidence bundle","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/evidences/download","href":"/reference/downloadrepresentmentbundle"},{"title":"Download an evidence file by ID","deprecated":null,"version":null,"sidebarTitle":"Download an evidence file by ID","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/disputes/{disputeId}/evidences/{evidenceId}","href":"/reference/downloaddisputeevidence"},{"title":"Remove an evidence file","deprecated":null,"version":null,"sidebarTitle":"Remove an evidence file","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /dispute/disputes/{disputeId}/evidences/{evidenceId}","href":"/reference/removedisputeevidence"},{"title":"Edit what a dispute's evidence shows","deprecated":null,"version":null,"sidebarTitle":"Edit what a dispute's evidence shows","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /dispute/disputes/{disputeId}/evidences/{evidenceId}/reading","href":"/reference/editdisputeevidencereading"},{"title":"Replace Dispute Tags by Type","deprecated":null,"version":null,"sidebarTitle":"Replace Dispute Tags by Type","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json put /dispute/disputes/{disputeId}/tags","href":"/reference/replacedisputetagsbytype"},{"title":"Attach Tags to a Dispute","deprecated":null,"version":null,"sidebarTitle":"Attach Tags to a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/disputes/{disputeId}/tags","href":"/reference/attachdisputetags"},{"title":"Detach a Tag from a Dispute","deprecated":null,"version":null,"sidebarTitle":"Detach a Tag from a Dispute","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /dispute/disputes/{disputeId}/tags/{tagId}","href":"/reference/detachdisputetag"},{"title":"List Tags","deprecated":null,"version":null,"sidebarTitle":"List Tags","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json get /dispute/tags","href":"/reference/listtags"},{"title":"Create Tag","deprecated":null,"version":null,"sidebarTitle":"Create Tag","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json post /dispute/tags","href":"/reference/createtag"},{"title":"Delete Tag","deprecated":null,"version":null,"sidebarTitle":"Delete Tag","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json delete /dispute/tags/{tagId}","href":"/reference/deletetag"},{"title":"Update Tag","deprecated":null,"version":null,"sidebarTitle":"Update Tag","openapi":"https://cdn.payrails.io/docs/api/openapi.min.json patch /dispute/tags/{tagId}","href":"/reference/updatetag"}]}]}]}]},"basePath":"","title":"Get payment by ID - Payrails Docs","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}