{
"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"
}
]
}
{
"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"
}
]
}
{
"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"
}
]
}
{
"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"
}
]
}
{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.conflict",
"detail": "The request operation is not allowed due to a conflict with the current state of the resource",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestconflict"
}
]
}
{
"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"
}
]
}
{
"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"
}
]
}
{
"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"
}
]
}
{
"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"
}
]
}
{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.conflict",
"detail": "The request operation is not allowed due to a conflict with the current state of the resource",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestconflict"
}
]
}
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
disputes:defend
Headers
x-idempotency-key
string<uuid>
required
Idempotency key to be used.
Sending again the same key would return the same result without re-executing the update.
Path Parameters
disputeId
string<uuid>
required
Identifier of the resource in Payrails.
Query Parameters
async
boolean
default:false
Submit stored evidence asynchronously without files. Poll GET dispute for status.
Body
multipart/form-data
providerReasonCode
string
required
Provider-specific reason code for the defense.
provenance
enum<string>
required
Provenance of the dispute evidence.
Available options:
Merchant,
Payrails,
Unknown
files[]
object[]
required
List of files supporting the dispute defense.
providerEvidenceTypeCodes
string[]
required
List of type codes for each file entry on files parameter.
Response
Defense submitted and dispute updated.
id
string<uuid>
required
Unique identifier of the Dispute in Payrails.
createdAt
string<date-time>
required
Date and time when the Dispute was created in Payrails.
updatedAt
string<date-time>
required
Date and time when the Dispute was last updated in Payrails.
providerId
string<uuid>
required
Unique identifier of the Provider that was used to process the
Dispute.
providerConfigId
string<uuid>
required
Unique identifier of the merchant-specific Provider Configuration
that was used to process the Dispute. This can include the set of
credentials used, the merchant account, country, vertical, etc.
providerReference
string
required
Unique identifier of the Dispute in the Provider.
stage
enum<string>
required
Stage of the dispute.
Available options:
Created,
FraudReport,
Retrieval,
Chargeback,
PreArbitration,
Arbitration,
Unknown
amount
object
Amount of the Dispute. May differ from amount of 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"
applicableDefenseReasons
object[]
List of reasons codes used when defending a Dispute.
Hide child attributes
applicableDefenseReasons.providerReasonCode
string
required
Defense reason code provided by Provider.
applicableDefenseReasons.title
string
Short display title of the defense reason. Set when the provider gives one; omitted otherwise.
applicableDefenseReasons.description
string
Longer explanation of the defense reason. Set when the provider gives one; omitted otherwise.
Longer explanation of the evidence type. Set when the provider gives one; omitted otherwise.
assignedToUserId
string<uuid>
assignedToUserEmail
string
Email of the user currently assigned to this dispute. Only present when includeUserEmail=true and a user is assigned.
channel
enum<string>
Channel the customer used to raise the dispute.
Not every provider reports a channel, and the field is only populated on
disputes received after it was introduced. It is therefore absent on many
disputes, and absence says nothing about how the dispute was raised — do not
read a missing channel as the absence of an issuer chargeback.
Provider: the customer raised the dispute with the payment provider
directly, without involving their bank.
Issuer: the customer went to their card issuer or bank, so the dispute
is a card chargeback.
Alert: the dispute arrived as a pre-chargeback alert, and no chargeback
has been raised yet.
Unknown: the Provider reported a channel that Payrails does not
recognize.
Available options:
Provider,
Issuer,
Alert,
Unknown
chargebackStatus
enum<string>
Status of the chargeback.
Available options:
Incoming,
Executed,
Reversed,
SecondChargeback,
IssuerReponseTimeframeExpired,
ArbitrationReversed
defenseStatus
enum<string>
Status of the defense.
Available options:
NotDefendable,
Undefended,
ReadyToSubmit,
Submitted,
Failed,
UnderReview,
Won,
Lost,
Accepted,
Resolved,
Unknown
defensePeriodExpiresAt
string<date-time>
Date and time when the Dispute defense period expires.
providerCreatedAt
string<date-time>
Date and time when the Dispute was created in the Provider. Only
present if informed by Provider.
merchantReference
string
Merchant-supplied reference for the payment that originated the
Dispute (e.g. an order ID). Populated from the PSP notification for
Adyen, PayPal, and Checkout.com disputes, or from the linked Payment
for other providers. Omitted when not available.
paymentId
string<uuid>
Unique identifier in Payrails of the Payment that originated the
Dispute. Only available if the Payment was created via Payrails. When
handling Disputes related to Payments created outside Payrails, this
field will be omitted.
workspaceId
string<uuid>
Workspace ID that the Dispute belongs to.
executionId
string
Unique identifier of the workflow execution that manages this
Dispute's lifecycle in Payrails. Present once the dispute-management
workflow has been started for the Dispute; omitted otherwise.
reason
string
Human-readable description of why the dispute was raised.
reasonCode
string
Provider-specific reason code for the dispute, when supplied by the Provider.
schemeReasonCode
string
Card-scheme reason code for the dispute, when supplied by the Provider.
issuerComments
object
Free-text comments from the issuer or provider about the dispute, keyed by
source. Populated for Adyen, Nuvei, PayPal, and Klarna disputes. Not
provided for Checkout.com, Stripe, or Revolut. Omitted when not available.
Hide child attributes
issuerComments.{key}
string
liabilityShifted
boolean | null
Indicates whether liability has shifted away from the merchant, as
determined by the Provider or by 3DS authentication data. When true,
the issuer bears the chargeback liability. Null if not yet determined.
payment
object
Hide child attributes
payment.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
payment.id
string<uuid>
Unique identifier of the Payment in Payrails. Omitted for Disputes on
Payments that were not created via Payrails.
payment.createdAt
string<date-time>
Exact date and time when the Payment was created. Possibly differs slightly from the date in the PSP.
payment.providerId
string<uuid>
Unique identifier of the Provider that was used to process the Payment.
payment.providerName
string
Name of the Provider that was used to process the Payment, e.g. Adyen, Checkout, Stripe.
payment.providerDisplayName
string
Display name of the Provider that was used to process the Payment.
payment.providerReference
string
Unique identifier of the Payment in an external system, e.g. PSP.
payment.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.
payment.providerIntegrationType
string
Type of integration used to process the payment (in case the payment provider supports multiple).
payment.paymentMethodType
string
Type of payment method used to process the payment.
payment.holderId
string<uuid>
Unique identifier of the Holder that is involved in the Payment.
payment.holderReference
string
Merchant-provided reference of the Holder involved in the Payment.
payment.amount
object
Amount of the Payment.
Hide child attributes
payment.amount.value
string
required
Decimal amount of the major currency unit. Can be any precision.
Pattern: [0-9]+(\.[0-9]+)?
Example:
"12.50"
payment.amount.currency
string
required
ISO 3-letter currency code.
Pattern: ^[A-Z]{3}$
Example:
"EUR"
payment.merchantReference
string
Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.
payment.acquirerReference
string
Acquirer Reference Number (ARN) of the Payment, assigned by the acquirer
and used by the card scheme to identify the transaction. Present only when
the Provider returns it.
Example:
"74537604221431003881865"
payment.workspaceId
string<uuid>
Workspace ID that the Payment belongs to.
payment.instrument
object
Optionally included details about the instrument used for the payment.
Hide child attributes
payment.instrument.id
string<uuid>
required
Id of the instrument.
payment.instrument.createdAt
string<date-time>
required
Date and time when the Instrument was created in Payrails.
payment.instrument.updatedAt
string<date-time>
required
When the Instrument was last updated.
payment.instrument.holderId
string<uuid>
required
Unique identifier of the Holder in Payrails.
payment.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
payment.instrument.status
enum<string>
required
Status of the instrument.
Available options:
created,
deleted,
enabled,
disabled,
transient
payment.instrument.displayName
string
Instrument name suitable for display.
payment.instrument.description
string
Description of the instrument.
payment.instrument.default
boolean | null
True if this instrument is set as default for the holder.
payment.instrument.merchantReference
string
Merchant-provided reference for the instrument.
payment.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.
payment.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
payment.instrument.networkTransactionReference
string
Identifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.
payment.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.
payment.instrument.data
Card · object
Type-specific information about the instrument.
Card
BankAccount
PayPal
GooglePay
ApplePay
DCB
MBWayDirect
Hide child attributes
payment.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
payment.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"
payment.instrument.data.suffix
string
required
Last digits of the Card number.
Required string length: 4
payment.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
payment.instrument.data.binLookup
object
Information about an issuer by the given BIN (or IIN).
Hide child attributes
payment.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"
payment.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
payment.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
payment.instrument.data.binLookup.issuer
string
Name of the bank or institution that issued the card.
payment.instrument.data.binLookup.issuerCountry
object
Country of the bank or institution that issued the card.
The English name of the country. Returned by Payrails, but not interpreted in requests.
payment.instrument.data.binLookup.segment
string
Segment of the card, e.g. gold, black, business.
payment.instrument.data.binLookup.type
string
Type of the card, e.g. credit, debit, prepaid, gift.
payment.instrument.data.binLookup.typeDetails
string
More information about the card type, e.g. personal, commercial.
payment.instrument.data.binLookup.isNetworkToken
boolean
Indicates whether the card credential represents a network token rather than a primary account number (PAN).
payment.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.
payment.instrument.data.billingAddress
object
Billing Address of the instrument.
Hide child attributes
payment.instrument.data.billingAddress.street
string
The name of the street of a postal address.
payment.instrument.data.billingAddress.doorNumber
string
The number on the door, building, or room.
payment.instrument.data.billingAddress.complement
string
Additional addressing information, 2nd line of postal address.
International prefix of the phone, if known separately.
Pattern: ^\+?[0-9]+$
payment.instrument.data.billingAddress.alias
string
Name of the address, e.g. home, work.
payment.instrument.data.billingAddress.name
string
Name of the person to whom the address belongs to.
payment.instrument.data.billingAddress.lastName
string
Last name of the person to whom the address belongs to.
payment.instrument.data.billingAddress.email
string
Email of the person to whom the address belongs to.
payment.instrument.data.expiryMonth
string
Expiry month of the Card.
Required string length: 2
payment.instrument.data.expiryYear
string
Expiry year of the Card.
Required string length: 4
payment.instrument.data.holderName
string
Name of the owner of the Card.
payment.instrument.data.taxId
string
Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument.
payment.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
payment.meta.order
object
The order being placed on your system. See Meta.order for every field.
payment.meta.customer
object
The customer placing the order. See Meta.customer for every field.
payment.meta.clientContext
object
Data describing the customer's device or browser. See Meta.clientContext for every field.
payment.meta.vendor
object
Description of a vendor that provides the order.
See Meta.vendor for every field.
payment.meta.risk
object
Configuration values for the risk prevention check. See Meta.risk for every field.
payment.meta.subscription
object
Configuration of a subscription process. See Meta.subscription for every field.
payment.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.
payment.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.
payment.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.
evidences
object[]
List of evidences associated with this dispute.
Hide child attributes
evidences.id
string<uuid>
required
Unique identifier of the Dispute in Payrails.
evidences.createdAt
string<date-time>
required
Date and time when the Dispute was created in Payrails.
evidences.updatedAt
string<date-time>
required
Date and time when the Dispute was last updated in Payrails.
evidences.displayTitle
string
Display title of the evidence, usually the file name.
evidences.status
enum<string>
Status of the dispute evidence.
Available options:
Active,
Inactive,
Unknown
evidences.provenance
enum<string>
Provenance of the dispute evidence.
Available options:
Merchant,
Payrails,
Unknown
evidences.contentType
string
MIME type of the evidence content.
evidences.contentLength
integer
Size of the evidence content in bytes.
evidences.payload
object
Inline JSON payload for inline-context evidences. Present only for evidences created from inlineContexts; omitted for file-backed evidence.
evidences.documentId
string<uuid>
Evidence library document this evidence is a version of. Present only for evidence library versions.
evidences.version
integer<int64>
Version number within the evidence library document. Present only for evidence library versions.
evidences.validFrom
string<date-time>
When this evidence library version starts to apply. Present only for evidence library versions.
evidences.changeNote
string
What changed in this evidence library version. Present only for evidence library versions that have a change note.
evidences.workspaceId
string<uuid>
Workspace ID that the Dispute belongs to.
evidences.labels
string[]
Labels assigned to this evidence for the dispute, used to categorise the document during representment.
evidences.submitted
boolean
True when the evidence was submitted with the representment plan. Set on a dispute's evidences and omitted when false.
evidences.sentToProviderAt
string<date-time>
When a successful defense last sent this evidence to the payment service provider. Set on a dispute's evidences and omitted when it was never sent.
evidences.exhibit
object
The dispute's exhibit metadata for this evidence. Present on a dispute's evidences when the dispute has any for it.
Hide child attributes
evidences.exhibit.kind
enum<string>
The defense section the exhibit supports.
Available options:
transaction,
proof-of-delivery,
customer-communication,
merchant-policy,
cancellation,
cardholder-authentication,
product-as-described
evidences.exhibit.source
string
Where the exhibit came from: library, upload, payrails_payments, or push: followed by the pushed record type.
evidences.exhibit.reading
string
What the exhibit shows, as the issuer reads it next to the file.
Maximum string length: 2000
evidences.exhibit.writtenBy
enum<string>
Who wrote the current reading.
Available options:
ai,
user
evidences.exhibit.updatedAt
string<date-time>
When the reading last changed.
submittedEvidences
object[]
The evidences the latest successful defense sent to the payment service provider, for both AI and manual defenses. Returned only when the request sets includeEvidences=true. Omitted when no defense has recorded what it sent, including defenses made before this field existed.
Hide child attributes
submittedEvidences.id
string<uuid>
required
Unique identifier of the Dispute in Payrails.
submittedEvidences.createdAt
string<date-time>
required
Date and time when the Dispute was created in Payrails.
submittedEvidences.updatedAt
string<date-time>
required
Date and time when the Dispute was last updated in Payrails.
submittedEvidences.displayTitle
string
Display title of the evidence, usually the file name.
submittedEvidences.status
enum<string>
Status of the dispute evidence.
Available options:
Active,
Inactive,
Unknown
submittedEvidences.provenance
enum<string>
Provenance of the dispute evidence.
Available options:
Merchant,
Payrails,
Unknown
submittedEvidences.contentType
string
MIME type of the evidence content.
submittedEvidences.contentLength
integer
Size of the evidence content in bytes.
submittedEvidences.payload
object
Inline JSON payload for inline-context evidences. Present only for evidences created from inlineContexts; omitted for file-backed evidence.
submittedEvidences.documentId
string<uuid>
Evidence library document this evidence is a version of. Present only for evidence library versions.
submittedEvidences.version
integer<int64>
Version number within the evidence library document. Present only for evidence library versions.
submittedEvidences.validFrom
string<date-time>
When this evidence library version starts to apply. Present only for evidence library versions.
submittedEvidences.changeNote
string
What changed in this evidence library version. Present only for evidence library versions that have a change note.
submittedEvidences.workspaceId
string<uuid>
Workspace ID that the Dispute belongs to.
submittedEvidences.labels
string[]
Labels assigned to this evidence for the dispute, used to categorise the document during representment.
submittedEvidences.submitted
boolean
True when the evidence was submitted with the representment plan. Set on a dispute's evidences and omitted when false.
submittedEvidences.sentToProviderAt
string<date-time>
When a successful defense last sent this evidence to the payment service provider. Set on a dispute's evidences and omitted when it was never sent.
submittedEvidences.exhibit
object
The dispute's exhibit metadata for this evidence. Present on a dispute's evidences when the dispute has any for it.
Hide child attributes
submittedEvidences.exhibit.kind
enum<string>
The defense section the exhibit supports.
Available options:
transaction,
proof-of-delivery,
customer-communication,
merchant-policy,
cancellation,
cardholder-authentication,
product-as-described
submittedEvidences.exhibit.source
string
Where the exhibit came from: library, upload, payrails_payments, or push: followed by the pushed record type.
submittedEvidences.exhibit.reading
string
What the exhibit shows, as the issuer reads it next to the file.
Maximum string length: 2000
submittedEvidences.exhibit.writtenBy
enum<string>
Who wrote the current reading.
Available options:
ai,
user
submittedEvidences.exhibit.updatedAt
string<date-time>
When the reading last changed.
representmentPlan
object
Representment plan details for this dispute.
Hide child attributes
representmentPlan.disputeId
string<uuid>
required
Unique identifier of the dispute in Payrails.
representmentPlan.createdAt
string<date-time>
required
Date and time when the representment plan was created in Payrails.
representmentPlan.updatedAt
string<date-time>
required
Date and time when the representment plan was last updated in Payrails.
representmentPlan.status
enum<string>
required
Status of the representment plan lifecycle.
Available options:
GeneratingPlan,
PlanReady,
StoringEvidences,
LabelingEvidences,
Failed,
EvidencesReady,
GeneratingRepresentment,
RepresentmentReady,
Submitted
representmentPlan.providerResponseId
string
Provider response identifier for representment plan generation.
representmentPlan.lastSectionGeneration
object
Outcome of the last completed defense section generation.
Win likelihood of the selected defense. Omitted when AI drafting is off, the plan recommends accepting, or no defense is selected.
Hide child attributes
representmentPlan.assessment.status
enum<string>
required
Whether the assessment can be shown. Always ready, as the assessment is computed on each read.
Available options:
ready
representmentPlan.assessment.likelihood
object
required
Hide child attributes
representmentPlan.assessment.likelihood.current
enum<string>
required
Band with the evidence attached now.
Available options:
low,
medium,
high
representmentPlan.assessment.likelihood.projected
enum<string>
Band if all missing required evidence were attached. Omitted when equal to current.
Available options:
low,
medium,
high
representmentPlan.assessment.missing
object[]
Required evidence no file covers, in plan order. Once the draft has a text section, only files a section links count. Omitted when none is missing.
Hide child attributes
representmentPlan.assessment.missing.evidenceSlug
string
required
Slug of the required evidence option.
representmentPlan.assessment.missing.sectionId
string<uuid>
ID of the text section the evidence belongs in. Omitted when no section fits.
representmentPlan.assessment.uncited
object[]
Evidence a text section links but its text does not cite, in document order. Omitted when there is none.
Hide child attributes
representmentPlan.assessment.uncited.sectionId
string<uuid>
required
ID of the text section.
representmentPlan.assessment.uncited.evidenceId
string<uuid>
required
ID of the evidence the section links.
representmentPlan.assessment.unsupported
object[]
Sentences in a text section's stored text that no evidence backs, in document order. A sentence drops off once it is cited or edited. Omitted when there is none.
Evidence embedded in the representment PDF, in exhibit order, computed from the current sections rather than the last generated PDF. Only present when includeRepresentmentSections=true.
Hide child attributes
representmentExhibits.evidenceId
string<uuid>
required
ID of the embedded evidence.
representmentExhibits.exhibitNumber
integer
required
Exhibit number shown in the PDF and its citations, starting at 1.
Required range: x >= 1
representmentPlanStatus
enum<string>
Status of the representment plan lifecycle.
Available options:
GeneratingPlan,
PlanReady,
StoringEvidences,
LabelingEvidences,
Failed,
EvidencesReady,
GeneratingRepresentment,
RepresentmentReady,
Submitted
tags
object[]
Tags attached to this dispute.
Hide child attributes
tags.id
string<uuid>
required
Unique identifier of the Tag.
tags.name
string
required
Human-readable display name of the Tag.
tags.slug
string
required
URL-safe identifier derived from the Tag name.
tags.color
string
required
Hex color code used to render the Tag (e.g. "#EF4444").
tags.type
string
required
Tag type slug. Determines cardinality and grouping (e.g. "merchant_status", "default").
tags.typeId
string<uuid>
required
UUID of the tag_types row this tag belongs to.
tags.cardinality
enum<string>
required
Whether multiple tags of this type can be attached to the same dispute at once. single means at most one tag of this type per dispute; multi allows many.
Available options:
single,
multi
tags.createdAt
string<date-time>
required
Date and time when the Tag was created.
tags.updatedAt
string<date-time>
required
Date and time when the Tag was last updated.
tags.workspaceId
string<uuid> | null
Workspace the Tag belongs to. Null for org-level tags visible to all workspaces.
tags.description
string | null
Optional description of the Tag.
tags.deletedAt
string<date-time> | null
Date and time when the Tag was soft-deleted. Null if active.
evidenceClassifications
object[]
AI classifications for the evidences associated with this dispute.
Only present when includeEvidenceClassifications=true.
Hide child attributes
evidenceClassifications.evidenceId
string<uuid>
required
Unique identifier of the evidence file that was classified.
evidenceClassifications.disputeId
string<uuid>
required
Unique identifier of the dispute the evidence belongs to.
evidenceClassifications.status
enum<string>
required
Classification status.
Available options:
classifying,
classified,
failed
evidenceClassifications.contentSummary
string
AI-generated summary of the evidence file content.
evidenceClassifications.documentType
string
AI-inferred document type (e.g. "receipt", "shipping_label").
evidenceClassifications.provesStatement
string
AI-generated statement of what the evidence proves in the dispute context.
evidenceClassifications.keyFacts
string[]
List of key facts extracted from the evidence.
evidenceClassifications.suggestedPlanMatches
object[]
Representment plan slots this evidence is suggested to fill, ordered by confidence.
AI-generated explanation for why this evidence matches the slot.
evidenceClassifications.providerResponseId
string
Identifier of the LLM provider response that produced this classification.
evidenceClassifications.createdAt
string<date-time>
Date and time when the classification was created.
evidenceClassifications.updatedAt
string<date-time>
Date and time when the classification was last updated.
defenseSubmission
object
Status of the asynchronous defense submission.
Hide child attributes
defenseSubmission.status
enum<string>
required
Current submission status.
Available options:
Submitting,
Submitted,
Failed
defenseSubmission.detail
string
Submission failure details.
evidenceSubmission
object
Status of the asynchronous evidence submission.
Hide child attributes
evidenceSubmission.status
enum<string>
required
Current submission status.
Available options:
Submitting,
Submitted,
Failed
evidenceSubmission.detail
string
Submission failure details.
{"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":"6afb337c935591d4867e5c97","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"Payment Orchestration","count":247},{"language":"default","tag":"Integrations","count":234},{"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":60},{"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":[],"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/defenddispute","slug":"/reference/defenddispute","pageMetadata":{"title":"Defend a Dispute","description":"Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated 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","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: \"Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated dispute.\"\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":"Defend a Dispute","description":"Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated 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","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":"Defend a Dispute","x-mint":{"metadata":{"description":"Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated dispute.","sidebarTitle":"Defend a Dispute"},"href":"/reference/defenddispute"},"operationId":"defendDispute","description":"Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated dispute.","tags":["Disputes"],"security":["b92b6c50-4d24-484c-b095-2f4d743290b0"],"parameters":["4b9563fb-0fda-448c-a83c-f9d7f91a8392","dbb5d3ae-a8b1-42c5-8343-138c4405cc98","6433564f-9435-422c-95af-ef99b4c21fb5"],"requestBody":"47752a00-ae61-4572-bb1a-59104c417465","responses":{"200":"9f54226f-a84c-4e86-874d-e0786caa131b","202":"5095946f-16d3-4dee-a8f3-3e7b9db3d0df","400":"43d6ecb5-89f9-40e4-9bb3-756b09941757","401":"f8cfd1ff-6db8-468e-8c7d-5e4824ba5b61","403":"b65bbb12-f351-478b-926f-1e2638416c85","404":"0b26eae1-b8c1-4cc4-80d5-6f44085cbedd","409":"c8a23794-8e2e-435a-af36-3fdcdbab9622","429":"efa55d10-a739-4ebb-bb9e-795f0f8abfbe","500":"9b1a4caa-f7f2-4e31-ac94-2e5ad0dd2be2"},"method":"post","type":"path","servers":["302dfc45-eef0-43da-a66e-60e8bf886c1e"],"path":"/dispute/disputes/{disputeId}/defend","baseUrlOptions":["https://api.eu.staging.payrails.io"],"title":"Defend a Dispute","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.providerReasonCode":"service_provided","body.provenance":"Merchant","body.files[].items.0":{"filename":["evidence_invoice.pdf","delivery_note.jpg"]},"body.files[].items.1":{"filename":["evidence_reason.pdf","reason_note.jpg"]},"body.providerEvidenceTypeCodes.items.0":"Invoice","body.providerEvidenceTypeCodes.items.1":"DefenseMaterial"}],"urlDisplay":"full"},"dependencies":{"parameters":{"4b9563fb-0fda-448c-a83c-f9d7f91a8392":{"name":"x-idempotency-key","in":"header","description":"Idempotency key to be used.\nSending again the same key would return the same result without re-executing the update.\n","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Idempotency key to be used.\nSending again the same key would return the same result without re-executing the update.\n","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"91874e4d-81e9-4486-aee4-ee1de84da890"},"dbb5d3ae-a8b1-42c5-8343-138c4405cc98":{"name":"disputeId","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"},"6433564f-9435-422c-95af-ef99b4c21fb5":{"name":"async","in":"query","description":"Submit stored evidence asynchronously without files. Poll GET dispute for status.","schema":{"type":"boolean","default":false,"description":"Submit stored evidence asynchronously without files. Poll GET dispute for status.","uniqueKey":"","typeLabel":"boolean"}}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["providerReasonCode","provenance","files[]","providerEvidenceTypeCodes"],"properties":{"providerReasonCode":{"type":"string","description":"Provider-specific reason code for the defense.","isRequired":true,"uniqueKey":"providerReasonCode","typeLabel":"string"},"provenance":{"type":"string","description":"Provenance of the dispute evidence.","enum":["Merchant","Payrails","Unknown"],"isRequired":true,"uniqueKey":"provenance","typeLabel":"enum\u003cstring>"},"files[]":{"type":"array","description":"List of files supporting the dispute defense.","items":{"type":"object","uniqueKey":"files[].items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"files[]","typeLabel":"object[]"},"providerEvidenceTypeCodes":{"type":"array","description":"List of type codes for each file entry on files parameter.","items":{"type":"string","uniqueKey":"providerEvidenceTypeCodes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"providerEvidenceTypeCodes","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"providerReasonCode":"service_provided","provenance":"Merchant","files[]":[{"filename":["evidence_invoice.pdf","delivery_note.jpg"]},{"filename":["evidence_reason.pdf","reason_note.jpg"]}],"providerEvidenceTypeCodes":["Invoice","DefenseMaterial"]},"examples":{"Example":{"title":"Example","value":{"providerReasonCode":"service_provided","provenance":"Merchant","files[]":[{"filename":["evidence_invoice.pdf","delivery_note.jpg"]},{"filename":["evidence_reason.pdf","reason_note.jpg"]}],"providerEvidenceTypeCodes":["Invoice","DefenseMaterial"]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"9f54226f-a84c-4e86-874d-e0786caa131b":{"description":"Defense submitted and dispute updated.","content":{"application/json":{"schema":{"type":"object","required":["id","createdAt","updatedAt","providerConfigId","providerId","providerReference","stage"],"properties":{"id":{"description":"Unique identifier of the Dispute in Payrails.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"createdAt":{"description":"Date and time when the Dispute was created in Payrails.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"Date and time when the Dispute was last updated in Payrails.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"providerId":{"description":"Unique identifier of the Provider that was used to process the\nDispute.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"providerId","typeLabel":"string\u003cuuid>"},"providerConfigId":{"description":"Unique identifier of the merchant-specific Provider Configuration\nthat was used to process the Dispute. This can include the set of\ncredentials used, the merchant account, country, vertical, etc.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"providerConfigId","typeLabel":"string\u003cuuid>"},"providerReference":{"description":"Unique identifier of the Dispute in the Provider.","type":"string","isRequired":true,"uniqueKey":"providerReference","typeLabel":"string"},"stage":{"type":"string","enum":["Created","FraudReport","Retrieval","Chargeback","PreArbitration","Arbitration","Unknown"],"description":"Stage of the dispute.","isRequired":true,"uniqueKey":"stage","typeLabel":"enum\u003cstring>"},"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 Dispute. May differ from amount of Payment.","uniqueKey":"amount","typeLabel":"object"},"applicableDefenseReasons":{"description":"List of reasons codes used when defending a Dispute.","type":"array","items":{"type":"object","required":["providerReasonCode"],"properties":{"providerReasonCode":{"description":"Defense reason code provided by Provider.","type":"string","isRequired":true,"uniqueKey":"applicableDefenseReasons.items.[INDEX].providerReasonCode","typeLabel":"string"},"title":{"description":"Short display title of the defense reason. Set when the provider gives one; omitted otherwise.","type":"string","uniqueKey":"applicableDefenseReasons.items.[INDEX].title","typeLabel":"string"},"description":{"description":"Longer explanation of the defense reason. Set when the provider gives one; omitted otherwise.","type":"string","uniqueKey":"applicableDefenseReasons.items.[INDEX].description","typeLabel":"string"},"evidenceTypes":{"type":"array","items":{"type":"object","required":["providerTypeCode"],"properties":{"providerTypeCode":{"description":"Code of the type of evidence provided by Provider.","type":"string","isRequired":true,"uniqueKey":"applicableDefenseReasons.items.[INDEX].evidenceTypes.items.[INDEX].providerTypeCode","typeLabel":"string"},"title":{"description":"Short display title of the evidence type. Set when the provider gives one; omitted otherwise.","type":"string","uniqueKey":"applicableDefenseReasons.items.[INDEX].evidenceTypes.items.[INDEX].title","typeLabel":"string"},"description":{"description":"Longer explanation of the evidence type. Set when the provider gives one; omitted otherwise.","type":"string","uniqueKey":"applicableDefenseReasons.items.[INDEX].evidenceTypes.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"applicableDefenseReasons.items.[INDEX].evidenceTypes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"applicableDefenseReasons.items.[INDEX].evidenceTypes","typeLabel":"object[]"}},"uniqueKey":"applicableDefenseReasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"applicableDefenseReasons","typeLabel":"object[]"},"assignedToUserId":{"type":"string","format":"uuid","uniqueKey":"assignedToUserId","typeLabel":"string\u003cuuid>"},"assignedToUserEmail":{"description":"Email of the user currently assigned to this dispute. Only present when includeUserEmail=true and a user is assigned.","type":"string","uniqueKey":"assignedToUserEmail","typeLabel":"string"},"channel":{"type":"string","enum":["Provider","Issuer","Alert","Unknown"],"description":"Channel the customer used to raise the dispute.\n\nNot every provider reports a channel, and the field is only populated on\ndisputes received after it was introduced. It is therefore absent on many\ndisputes, and absence says nothing about how the dispute was raised — do not\nread a missing `channel` as the absence of an issuer chargeback.\n\n- `Provider`: the customer raised the dispute with the payment provider\n directly, without involving their bank.\n- `Issuer`: the customer went to their card issuer or bank, so the dispute\n is a card chargeback.\n- `Alert`: the dispute arrived as a pre-chargeback alert, and no chargeback\n has been raised yet.\n- `Unknown`: the Provider reported a channel that Payrails does not\n recognize.","uniqueKey":"channel","typeLabel":"enum\u003cstring>"},"chargebackStatus":{"type":"string","enum":["Incoming","Executed","Reversed","SecondChargeback","IssuerReponseTimeframeExpired","ArbitrationReversed"],"description":"Status of the chargeback.","uniqueKey":"chargebackStatus","typeLabel":"enum\u003cstring>"},"defenseStatus":{"type":"string","enum":["NotDefendable","Undefended","ReadyToSubmit","Submitted","Failed","UnderReview","Won","Lost","Accepted","Resolved","Unknown"],"description":"Status of the defense.","uniqueKey":"defenseStatus","typeLabel":"enum\u003cstring>"},"defensePeriodExpiresAt":{"description":"Date and time when the Dispute defense period expires.","format":"date-time","type":"string","uniqueKey":"defensePeriodExpiresAt","typeLabel":"string\u003cdate-time>"},"providerCreatedAt":{"description":"Date and time when the Dispute was created in the Provider. Only\npresent if informed by Provider.","format":"date-time","type":"string","uniqueKey":"providerCreatedAt","typeLabel":"string\u003cdate-time>"},"merchantReference":{"description":"Merchant-supplied reference for the payment that originated the\nDispute (e.g. an order ID). Populated from the PSP notification for\nAdyen, PayPal, and Checkout.com disputes, or from the linked Payment\nfor other providers. Omitted when not available.","type":"string","uniqueKey":"merchantReference","typeLabel":"string"},"paymentId":{"description":"Unique identifier in Payrails of the Payment that originated the\nDispute. Only available if the Payment was created via Payrails. When\nhandling Disputes related to Payments created outside Payrails, this\nfield will be omitted.","format":"uuid","type":"string","uniqueKey":"paymentId","typeLabel":"string\u003cuuid>"},"workspaceId":{"description":"Workspace ID that the Dispute belongs to.","format":"uuid","type":"string","uniqueKey":"workspaceId","typeLabel":"string\u003cuuid>"},"executionId":{"description":"Unique identifier of the workflow execution that manages this\nDispute's lifecycle in Payrails. Present once the dispute-management\nworkflow has been started for the Dispute; omitted otherwise.","type":"string","uniqueKey":"executionId","typeLabel":"string"},"reason":{"type":"string","description":"Human-readable description of why the dispute was raised.","uniqueKey":"reason","typeLabel":"string"},"reasonCode":{"type":"string","description":"Provider-specific reason code for the dispute, when supplied by the Provider.","uniqueKey":"reasonCode","typeLabel":"string"},"schemeReasonCode":{"type":"string","description":"Card-scheme reason code for the dispute, when supplied by the Provider.","uniqueKey":"schemeReasonCode","typeLabel":"string"},"issuerComments":{"description":"Free-text comments from the issuer or provider about the dispute, keyed by\nsource. Populated for Adyen, Nuvei, PayPal, and Klarna disputes. Not\nprovided for Checkout.com, Stripe, or Revolut. Omitted when not available.","additionalProperties":{"type":"string","uniqueKey":"issuerComments.additionalProperties","typeLabel":"string"},"type":"object","uniqueKey":"issuerComments","typeLabel":"object"},"liabilityShifted":{"oneOf":[{"description":"Indicates whether liability has shifted away from the merchant, as\ndetermined by the Provider or by 3DS authentication data. When true,\nthe issuer bears the chargeback liability. Null if not yet determined.","type":"boolean","uniqueKey":"liabilityShifted.oneOf.0","typeLabel":"boolean"},{"description":"Indicates whether liability has shifted away from the merchant, as\ndetermined by the Provider or by 3DS authentication data. When true,\nthe issuer bears the chargeback liability. Null if not yet determined.","type":"null","uniqueKey":"liabilityShifted.oneOf.1","typeLabel":"null"}],"uniqueKey":"liabilityShifted","typeLabel":"boolean | null"},"payment":{"type":"object","required":["status"],"properties":{"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":"payment.status","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the Payment in Payrails. Omitted for Disputes on\nPayments that were not created via Payrails.","uniqueKey":"payment.id","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","description":"Exact date and time when the Payment was created. Possibly differs slightly from the date in the PSP.","uniqueKey":"payment.createdAt","typeLabel":"string\u003cdate-time>"},"providerId":{"type":"string","format":"uuid","description":"Unique identifier of the Provider that was used to process the Payment.","uniqueKey":"payment.providerId","typeLabel":"string\u003cuuid>"},"providerName":{"type":"string","description":"Name of the Provider that was used to process the Payment, e.g. Adyen, Checkout, Stripe.","uniqueKey":"payment.providerName","typeLabel":"string"},"providerDisplayName":{"type":"string","description":"Display name of the Provider that was used to process the Payment.","uniqueKey":"payment.providerDisplayName","typeLabel":"string"},"providerReference":{"type":"string","description":"Unique identifier of the Payment in an external system, e.g. PSP.","uniqueKey":"payment.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":"payment.providerConfigId","typeLabel":"string\u003cuuid>"},"providerIntegrationType":{"type":"string","description":"Type of integration used to process the payment (in case the payment provider supports multiple).","uniqueKey":"payment.providerIntegrationType","typeLabel":"string"},"paymentMethodType":{"type":"string","description":"Type of payment method used to process the payment.","uniqueKey":"payment.paymentMethodType","typeLabel":"string"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder that is involved in the Payment.","uniqueKey":"payment.holderId","typeLabel":"string\u003cuuid>"},"holderReference":{"type":"string","description":"Merchant-provided reference of the Holder involved in the Payment.","uniqueKey":"payment.holderReference","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":"payment.amount.value","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","description":"ISO 3-letter currency code.","isRequired":true,"uniqueKey":"payment.amount.currency","typeLabel":"string"}},"description":"Amount of the Payment.","uniqueKey":"payment.amount","typeLabel":"object"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.","uniqueKey":"payment.merchantReference","typeLabel":"string"},"acquirerReference":{"type":"string","description":"Acquirer Reference Number (ARN) of the Payment, assigned by the acquirer\nand used by the card scheme to identify the transaction. Present only when\nthe Provider returns it.","example":"74537604221431003881865","uniqueKey":"payment.acquirerReference","typeLabel":"string"},"workspaceId":{"type":"string","format":"uuid","description":"Workspace ID that the Payment belongs to.","uniqueKey":"payment.workspaceId","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":"payment.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":"payment.instrument.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the Instrument was last updated.","isRequired":true,"uniqueKey":"payment.instrument.updatedAt","typeLabel":"string\u003cdate-time>"},"holderId":{"type":"string","format":"uuid","description":"Unique identifier of the Holder in Payrails.","isRequired":true,"uniqueKey":"payment.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":"payment.instrument.paymentMethod","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Status of the instrument.","enum":["created","deleted","enabled","disabled","transient"],"isRequired":true,"uniqueKey":"payment.instrument.status","typeLabel":"enum\u003cstring>"},"displayName":{"type":"string","description":"Instrument name suitable for display.","uniqueKey":"payment.instrument.displayName","typeLabel":"string"},"description":{"type":"string","description":"Description of the instrument.","uniqueKey":"payment.instrument.description","typeLabel":"string"},"default":{"oneOf":[{"type":"boolean","description":"True if this instrument is set as default for the holder.","uniqueKey":"payment.instrument.default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True if this instrument is set as default for the holder.","uniqueKey":"payment.instrument.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.instrument.default","typeLabel":"boolean | null"},"merchantReference":{"type":"string","description":"Merchant-provided reference for the instrument.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.0.bin","typeLabel":"string"},"suffix":{"type":"string","minLength":4,"maxLength":4,"description":"Last digits of the Card number.","isRequired":true,"uniqueKey":"payment.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":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.0.binLookup.localNetwork","typeLabel":"enum\u003cstring>"},"issuer":{"type":"string","description":"Name of the bank or institution that issued the card.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.0.binLookup.issuerCountry.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.0.binLookup.issuerCountry","typeLabel":"object"},"segment":{"type":"string","description":"Segment of the card, e.g. gold, black, business.","uniqueKey":"payment.instrument.data.oneOf.0.binLookup.segment","typeLabel":"string"},"type":{"type":"string","description":"Type of the card, e.g. credit, debit, prepaid, gift.","uniqueKey":"payment.instrument.data.oneOf.0.binLookup.type","typeLabel":"string"},"typeDetails":{"type":"string","description":"More information about the card type, e.g. personal, commercial.","uniqueKey":"payment.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":"payment.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":"payment.instrument.data.oneOf.0.binLookup.isFlexCard","typeLabel":"boolean"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.0.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.0.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.0.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.0.billingAddress.email","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.0.billingAddress","typeLabel":"object"},"expiryMonth":{"type":"string","minLength":2,"maxLength":2,"description":"Expiry month of the Card.","uniqueKey":"payment.instrument.data.oneOf.0.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","minLength":4,"maxLength":4,"description":"Expiry year of the Card.","uniqueKey":"payment.instrument.data.oneOf.0.expiryYear","typeLabel":"string"},"holderName":{"type":"string","description":"Name of the owner of the Card.","uniqueKey":"payment.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":"payment.instrument.data.oneOf.0.taxId","typeLabel":"string"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.1.holder.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"The last name of the account holder.","uniqueKey":"payment.instrument.data.oneOf.1.holder.lastName","typeLabel":"string"},"companyName":{"type":"string","description":"The company name for business holders.","uniqueKey":"payment.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":"payment.instrument.data.oneOf.1.holder.address.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"payment.instrument.data.oneOf.1.holder.address.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"payment.instrument.data.oneOf.1.holder.address.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"payment.instrument.data.oneOf.1.holder.address.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"payment.instrument.data.oneOf.1.holder.address.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"payment.instrument.data.oneOf.1.holder.address.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.1.holder.address.country.name","typeLabel":"string"}},"uniqueKey":"payment.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":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.1.holder.address.phone.countryCode","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.1.holder.address.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"payment.instrument.data.oneOf.1.holder.address.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"payment.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":"payment.instrument.data.oneOf.1.holder.address.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.1.holder.address.email","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.1.holder.address","typeLabel":"object"},"email":{"type":"string","format":"email","description":"The email address of the account holder.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.1.holder.country.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.1.holder.country","typeLabel":"object"},"city":{"type":"string","description":"The city of the account holder.","uniqueKey":"payment.instrument.data.oneOf.1.holder.city","typeLabel":"string"},"type":{"type":"string","enum":["individual","corporate"],"description":"The type of account holder.","uniqueKey":"payment.instrument.data.oneOf.1.holder.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.1.bank.name","typeLabel":"string"},"branchCode":{"type":"string","description":"The branch code of the bank.","uniqueKey":"payment.instrument.data.oneOf.1.bank.branchCode","typeLabel":"string"},"code":{"type":"string","description":"The bank code.","uniqueKey":"payment.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":"payment.instrument.data.oneOf.1.bank.address.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"payment.instrument.data.oneOf.1.bank.address.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"payment.instrument.data.oneOf.1.bank.address.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"payment.instrument.data.oneOf.1.bank.address.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"payment.instrument.data.oneOf.1.bank.address.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"payment.instrument.data.oneOf.1.bank.address.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.1.bank.address.country.name","typeLabel":"string"}},"uniqueKey":"payment.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":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.1.bank.address.phone.countryCode","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.1.bank.address.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"payment.instrument.data.oneOf.1.bank.address.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"payment.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":"payment.instrument.data.oneOf.1.bank.address.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.1.bank.address.email","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.1.bank.address","typeLabel":"object"},"swiftCode":{"type":"string","description":"The SWIFT/BIC code of the bank.","uniqueKey":"payment.instrument.data.oneOf.1.bank.swiftCode","typeLabel":"string"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.1.account.number","typeLabel":"string"},"iban":{"type":"string","description":"The International Bank Account Number (IBAN).","uniqueKey":"payment.instrument.data.oneOf.1.account.iban","typeLabel":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"USD","description":"ISO 3-letter currency code.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.1.account.country.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.1.account.country","typeLabel":"object"},"type":{"type":"string","enum":["savings","current"],"description":"The type of bank account.","uniqueKey":"payment.instrument.data.oneOf.1.account.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment.instrument.data.oneOf.1.account","typeLabel":"object"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.2.email","typeLabel":"string"},"payerId":{"type":"string","description":"ID of the PayPal payer account.","uniqueKey":"payment.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":"payment.instrument.data.oneOf.2.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.2.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.2.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.2.billingAddress.email","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.2.billingAddress","typeLabel":"object"}},"uniqueKey":"payment.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":"payment.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":"payment.instrument.data.oneOf.3.suffix","typeLabel":"string"},"networkDisplayName":{"type":"string","description":"Display-friendly name of the network.","uniqueKey":"payment.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":"payment.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":"payment.instrument.data.oneOf.3.binLookup.localNetwork","typeLabel":"enum\u003cstring>"},"issuer":{"type":"string","description":"Name of the bank or institution that issued the card.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.3.binLookup.issuerCountry.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.3.binLookup.issuerCountry","typeLabel":"object"},"segment":{"type":"string","description":"Segment of the card, e.g. gold, black, business.","uniqueKey":"payment.instrument.data.oneOf.3.binLookup.segment","typeLabel":"string"},"type":{"type":"string","description":"Type of the card, e.g. credit, debit, prepaid, gift.","uniqueKey":"payment.instrument.data.oneOf.3.binLookup.type","typeLabel":"string"},"typeDetails":{"type":"string","description":"More information about the card type, e.g. personal, commercial.","uniqueKey":"payment.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":"payment.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":"payment.instrument.data.oneOf.3.binLookup.isFlexCard","typeLabel":"boolean"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.3.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.3.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.3.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.3.billingAddress.email","typeLabel":"string"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.3.shippingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.3.shippingAddress.country.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.3.shippingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress.email","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.3.shippingAddress","typeLabel":"object"},"expiryMonth":{"type":"string","minLength":2,"maxLength":2,"description":"Expiry month of the Card.","uniqueKey":"payment.instrument.data.oneOf.3.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","minLength":4,"maxLength":4,"description":"Expiry year of the Card.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.3.cardHolderAuthenticated","typeLabel":"boolean"},"googleMessageId":{"type":"string","description":"Unique identifier for the Google Pay message.","uniqueKey":"payment.instrument.data.oneOf.3.googleMessageId","typeLabel":"string"},"googleMessageExpirationId":{"type":"string","description":"Expiration time for the Google Pay message.","uniqueKey":"payment.instrument.data.oneOf.3.googleMessageExpirationId","typeLabel":"string"}},"uniqueKey":"payment.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":"payment.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":"payment.instrument.data.oneOf.4.suffix","typeLabel":"string"},"networkDisplayName":{"type":"string","description":"Display-friendly name of the network.","uniqueKey":"payment.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":"payment.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":"payment.instrument.data.oneOf.4.binLookup.localNetwork","typeLabel":"enum\u003cstring>"},"issuer":{"type":"string","description":"Name of the bank or institution that issued the card.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.4.binLookup.issuerCountry.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.4.binLookup.issuerCountry","typeLabel":"object"},"segment":{"type":"string","description":"Segment of the card, e.g. gold, black, business.","uniqueKey":"payment.instrument.data.oneOf.4.binLookup.segment","typeLabel":"string"},"type":{"type":"string","description":"Type of the card, e.g. credit, debit, prepaid, gift.","uniqueKey":"payment.instrument.data.oneOf.4.binLookup.type","typeLabel":"string"},"typeDetails":{"type":"string","description":"More information about the card type, e.g. personal, commercial.","uniqueKey":"payment.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":"payment.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":"payment.instrument.data.oneOf.4.binLookup.isFlexCard","typeLabel":"boolean"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.4.billingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.4.billingAddress.country.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.4.billingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.4.billingAddress.email","typeLabel":"string"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.4.shippingAddress.street","typeLabel":"string"},"doorNumber":{"type":"string","description":"The number on the door, building, or room.","uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.doorNumber","typeLabel":"string"},"complement":{"type":"string","description":"Additional addressing information, 2nd line of postal address.","uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.complement","typeLabel":"string"},"area":{"type":"string","description":"The name of the suburb or area within a city.","uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.area","typeLabel":"string"},"city":{"type":"string","description":"The name of the city of a postal address.","uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.city","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code.","uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"The name of the state a postal address is in.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.4.shippingAddress.country.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.country","typeLabel":"object"},"latitude":{"type":"number","format":"float","description":"Latitude of the address in the GPS coordinate system.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.4.shippingAddress.phone.countryCode","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.phone","typeLabel":"object"},"alias":{"type":"string","description":"Name of the address, e.g. home, work.","uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.alias","typeLabel":"string"},"name":{"type":"string","description":"Name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email of the person to whom the address belongs to.","uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress.email","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.4.shippingAddress","typeLabel":"object"},"expiryMonth":{"type":"string","minLength":2,"maxLength":2,"description":"Expiry month of the Card.","uniqueKey":"payment.instrument.data.oneOf.4.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","minLength":4,"maxLength":4,"description":"Expiry year of the Card.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.4.cardHolderAuthenticated","typeLabel":"boolean"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.5.msisdn","typeLabel":"string"},"msisdnTail":{"type":"string","description":"Last 4 digits of the mobile number of the holder.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.instrument.data.oneOf.5.country.name","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.5.country","typeLabel":"object"},"carrierNetwork":{"type":"string","description":"Carrier network of the msisdn.","uniqueKey":"payment.instrument.data.oneOf.5.carrierNetwork","typeLabel":"string"}},"uniqueKey":"payment.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":"payment.instrument.data.oneOf.6.phone.countryCode","typeLabel":"string"},"number":{"type":"string","description":"National number, digits only.","example":"912345678","uniqueKey":"payment.instrument.data.oneOf.6.phone.number","typeLabel":"string"}},"uniqueKey":"payment.instrument.data.oneOf.6.phone","typeLabel":"object"}},"uniqueKey":"payment.instrument.data.oneOf.6","typeLabel":"MBWayDirect · object"}],"uniqueKey":"payment.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":"payment.instrument","typeLabel":"object"},"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":"payment.meta.order","typeLabel":"object"},"customer":{"type":"object","description":"The customer placing the order. See [Meta.customer](/reference/meta#schema-customer) for every field.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.meta.risk","typeLabel":"object"},"subscription":{"type":"object","description":"Configuration of a subscription process. See [Meta.subscription](/reference/meta#schema-subscription) for every field.","uniqueKey":"payment.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":"payment.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":"payment.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":"payment.meta.upi","typeLabel":"any"}},"uniqueKey":"payment.meta","typeLabel":"object"}},"uniqueKey":"payment","typeLabel":"object"},"evidences":{"description":"List of evidences associated with this dispute.","type":"array","items":{"type":"object","required":["id","createdAt","updatedAt"],"properties":{"id":{"description":"Unique identifier of the Dispute in Payrails.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"evidences.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"createdAt":{"description":"Date and time when the Dispute was created in Payrails.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"evidences.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"Date and time when the Dispute was last updated in Payrails.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"evidences.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"displayTitle":{"description":"Display title of the evidence, usually the file name.","type":"string","uniqueKey":"evidences.items.[INDEX].displayTitle","typeLabel":"string"},"status":{"type":"string","description":"Status of the dispute evidence.","enum":["Active","Inactive","Unknown"],"uniqueKey":"evidences.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"provenance":{"type":"string","description":"Provenance of the dispute evidence.","enum":["Merchant","Payrails","Unknown"],"uniqueKey":"evidences.items.[INDEX].provenance","typeLabel":"enum\u003cstring>"},"contentType":{"description":"MIME type of the evidence content.","type":"string","uniqueKey":"evidences.items.[INDEX].contentType","typeLabel":"string"},"contentLength":{"description":"Size of the evidence content in bytes.","type":"integer","uniqueKey":"evidences.items.[INDEX].contentLength","typeLabel":"integer"},"payload":{"description":"Inline JSON payload for inline-context evidences. Present only for evidences created from `inlineContexts`; omitted for file-backed evidence.","type":"object","additionalProperties":true,"uniqueKey":"evidences.items.[INDEX].payload","typeLabel":"object"},"documentId":{"description":"Evidence library document this evidence is a version of. Present only for evidence library versions.","format":"uuid","type":"string","uniqueKey":"evidences.items.[INDEX].documentId","typeLabel":"string\u003cuuid>"},"version":{"description":"Version number within the evidence library document. Present only for evidence library versions.","type":"integer","format":"int64","uniqueKey":"evidences.items.[INDEX].version","typeLabel":"integer\u003cint64>"},"validFrom":{"description":"When this evidence library version starts to apply. Present only for evidence library versions.","format":"date-time","type":"string","uniqueKey":"evidences.items.[INDEX].validFrom","typeLabel":"string\u003cdate-time>"},"changeNote":{"description":"What changed in this evidence library version. Present only for evidence library versions that have a change note.","type":"string","uniqueKey":"evidences.items.[INDEX].changeNote","typeLabel":"string"},"workspaceId":{"description":"Workspace ID that the Dispute belongs to.","format":"uuid","type":"string","uniqueKey":"evidences.items.[INDEX].workspaceId","typeLabel":"string\u003cuuid>"},"labels":{"description":"Labels assigned to this evidence for the dispute, used to categorise the document during representment.","type":"array","items":{"type":"string","uniqueKey":"evidences.items.[INDEX].labels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"evidences.items.[INDEX].labels","typeLabel":"string[]"},"submitted":{"type":"boolean","description":"True when the evidence was submitted with the representment plan. Set on a dispute's evidences and omitted when false.","uniqueKey":"evidences.items.[INDEX].submitted","typeLabel":"boolean"},"sentToProviderAt":{"type":"string","format":"date-time","description":"When a successful defense last sent this evidence to the payment service provider. Set on a dispute's evidences and omitted when it was never sent.","uniqueKey":"evidences.items.[INDEX].sentToProviderAt","typeLabel":"string\u003cdate-time>"},"exhibit":{"description":"The dispute's exhibit metadata for this evidence. Present on a dispute's evidences when the dispute has any for it.","type":"object","properties":{"kind":{"type":"string","description":"The defense section the exhibit supports.","enum":["transaction","proof-of-delivery","customer-communication","merchant-policy","cancellation","cardholder-authentication","product-as-described"],"uniqueKey":"evidences.items.[INDEX].exhibit.kind","typeLabel":"enum\u003cstring>"},"source":{"type":"string","description":"Where the exhibit came from: `library`, `upload`, `payrails_payments`, or `push:` followed by the pushed record type.","uniqueKey":"evidences.items.[INDEX].exhibit.source","typeLabel":"string"},"reading":{"type":"string","maxLength":2000,"description":"What the exhibit shows, as the issuer reads it next to the file.","uniqueKey":"evidences.items.[INDEX].exhibit.reading","typeLabel":"string"},"writtenBy":{"type":"string","description":"Who wrote the current reading.","enum":["ai","user"],"uniqueKey":"evidences.items.[INDEX].exhibit.writtenBy","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"string","format":"date-time","description":"When the reading last changed.","uniqueKey":"evidences.items.[INDEX].exhibit.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"evidences.items.[INDEX].exhibit","typeLabel":"object"}},"uniqueKey":"evidences.items.[INDEX]","typeLabel":"object"},"uniqueKey":"evidences","typeLabel":"object[]"},"submittedEvidences":{"description":"The evidences the latest successful defense sent to the payment service provider, for both AI and manual defenses. Returned only when the request sets includeEvidences=true. Omitted when no defense has recorded what it sent, including defenses made before this field existed.","type":"array","items":{"type":"object","required":["id","createdAt","updatedAt"],"properties":{"id":{"description":"Unique identifier of the Dispute in Payrails.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"submittedEvidences.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"createdAt":{"description":"Date and time when the Dispute was created in Payrails.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"submittedEvidences.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"Date and time when the Dispute was last updated in Payrails.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"submittedEvidences.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"displayTitle":{"description":"Display title of the evidence, usually the file name.","type":"string","uniqueKey":"submittedEvidences.items.[INDEX].displayTitle","typeLabel":"string"},"status":{"type":"string","description":"Status of the dispute evidence.","enum":["Active","Inactive","Unknown"],"uniqueKey":"submittedEvidences.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"provenance":{"type":"string","description":"Provenance of the dispute evidence.","enum":["Merchant","Payrails","Unknown"],"uniqueKey":"submittedEvidences.items.[INDEX].provenance","typeLabel":"enum\u003cstring>"},"contentType":{"description":"MIME type of the evidence content.","type":"string","uniqueKey":"submittedEvidences.items.[INDEX].contentType","typeLabel":"string"},"contentLength":{"description":"Size of the evidence content in bytes.","type":"integer","uniqueKey":"submittedEvidences.items.[INDEX].contentLength","typeLabel":"integer"},"payload":{"description":"Inline JSON payload for inline-context evidences. Present only for evidences created from `inlineContexts`; omitted for file-backed evidence.","type":"object","additionalProperties":true,"uniqueKey":"submittedEvidences.items.[INDEX].payload","typeLabel":"object"},"documentId":{"description":"Evidence library document this evidence is a version of. Present only for evidence library versions.","format":"uuid","type":"string","uniqueKey":"submittedEvidences.items.[INDEX].documentId","typeLabel":"string\u003cuuid>"},"version":{"description":"Version number within the evidence library document. Present only for evidence library versions.","type":"integer","format":"int64","uniqueKey":"submittedEvidences.items.[INDEX].version","typeLabel":"integer\u003cint64>"},"validFrom":{"description":"When this evidence library version starts to apply. Present only for evidence library versions.","format":"date-time","type":"string","uniqueKey":"submittedEvidences.items.[INDEX].validFrom","typeLabel":"string\u003cdate-time>"},"changeNote":{"description":"What changed in this evidence library version. Present only for evidence library versions that have a change note.","type":"string","uniqueKey":"submittedEvidences.items.[INDEX].changeNote","typeLabel":"string"},"workspaceId":{"description":"Workspace ID that the Dispute belongs to.","format":"uuid","type":"string","uniqueKey":"submittedEvidences.items.[INDEX].workspaceId","typeLabel":"string\u003cuuid>"},"labels":{"description":"Labels assigned to this evidence for the dispute, used to categorise the document during representment.","type":"array","items":{"type":"string","uniqueKey":"submittedEvidences.items.[INDEX].labels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"submittedEvidences.items.[INDEX].labels","typeLabel":"string[]"},"submitted":{"type":"boolean","description":"True when the evidence was submitted with the representment plan. Set on a dispute's evidences and omitted when false.","uniqueKey":"submittedEvidences.items.[INDEX].submitted","typeLabel":"boolean"},"sentToProviderAt":{"type":"string","format":"date-time","description":"When a successful defense last sent this evidence to the payment service provider. Set on a dispute's evidences and omitted when it was never sent.","uniqueKey":"submittedEvidences.items.[INDEX].sentToProviderAt","typeLabel":"string\u003cdate-time>"},"exhibit":{"description":"The dispute's exhibit metadata for this evidence. Present on a dispute's evidences when the dispute has any for it.","type":"object","properties":{"kind":{"type":"string","description":"The defense section the exhibit supports.","enum":["transaction","proof-of-delivery","customer-communication","merchant-policy","cancellation","cardholder-authentication","product-as-described"],"uniqueKey":"submittedEvidences.items.[INDEX].exhibit.kind","typeLabel":"enum\u003cstring>"},"source":{"type":"string","description":"Where the exhibit came from: `library`, `upload`, `payrails_payments`, or `push:` followed by the pushed record type.","uniqueKey":"submittedEvidences.items.[INDEX].exhibit.source","typeLabel":"string"},"reading":{"type":"string","maxLength":2000,"description":"What the exhibit shows, as the issuer reads it next to the file.","uniqueKey":"submittedEvidences.items.[INDEX].exhibit.reading","typeLabel":"string"},"writtenBy":{"type":"string","description":"Who wrote the current reading.","enum":["ai","user"],"uniqueKey":"submittedEvidences.items.[INDEX].exhibit.writtenBy","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"string","format":"date-time","description":"When the reading last changed.","uniqueKey":"submittedEvidences.items.[INDEX].exhibit.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"submittedEvidences.items.[INDEX].exhibit","typeLabel":"object"}},"uniqueKey":"submittedEvidences.items.[INDEX]","typeLabel":"object"},"uniqueKey":"submittedEvidences","typeLabel":"object[]"},"representmentPlan":{"description":"Representment plan details for this dispute.","type":"object","required":["disputeId","createdAt","updatedAt","status"],"properties":{"disputeId":{"description":"Unique identifier of the dispute in Payrails.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"representmentPlan.disputeId","typeLabel":"string\u003cuuid>"},"createdAt":{"description":"Date and time when the representment plan was created in Payrails.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"representmentPlan.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"Date and time when the representment plan was last updated in Payrails.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"representmentPlan.updatedAt","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","description":"Status of the representment plan lifecycle.","enum":["GeneratingPlan","PlanReady","StoringEvidences","LabelingEvidences","Failed","EvidencesReady","GeneratingRepresentment","RepresentmentReady","Submitted"],"isRequired":true,"uniqueKey":"representmentPlan.status","typeLabel":"enum\u003cstring>"},"providerResponseId":{"description":"Provider response identifier for representment plan generation.","type":"string","uniqueKey":"representmentPlan.providerResponseId","typeLabel":"string"},"lastSectionGeneration":{"description":"Outcome of the last completed defense section generation.","type":"object","required":["succeeded","completedAt"],"properties":{"succeeded":{"description":"Whether defense section generation succeeded.","type":"boolean","isRequired":true,"uniqueKey":"representmentPlan.lastSectionGeneration.succeeded","typeLabel":"boolean"},"completedAt":{"description":"Date and time when defense section generation completed.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"representmentPlan.lastSectionGeneration.completedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"representmentPlan.lastSectionGeneration","typeLabel":"object"},"recommendation":{"description":"Recommended action for the merchant (e.g. \"defend\" or \"accept\").","type":"string","uniqueKey":"representmentPlan.recommendation","typeLabel":"string"},"rationale":{"description":"Explanation supporting the recommendation.","type":"string","uniqueKey":"representmentPlan.rationale","typeLabel":"string"},"defenseReasons":{"description":"Defense reason codes with evidence options, grouped by provider reason code.","type":"array","items":{"type":"object","required":["code","title","description","selected","options"],"properties":{"code":{"description":"Adyen defense document type code.","type":"string","isRequired":true,"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].code","typeLabel":"string"},"title":{"description":"Human-readable name for this defense document type.","type":"string","isRequired":true,"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].title","typeLabel":"string"},"description":{"description":"Explanation of what this defense document type covers.","type":"string","isRequired":true,"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].description","typeLabel":"string"},"selected":{"description":"Whether this defense type is the recommended selection.","type":"boolean","isRequired":true,"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].selected","typeLabel":"boolean"},"options":{"description":"Evidence suggestions within this defense type.","type":"array","items":{"type":"object","required":["position","title","description","required"],"properties":{"position":{"description":"Ordering position of this option within the defense type.","type":"integer","isRequired":true,"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX].position","typeLabel":"integer"},"title":{"description":"Suggested title for this evidence.","type":"string","isRequired":true,"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX].title","typeLabel":"string"},"description":{"description":"Suggested details to include for this evidence.","type":"string","isRequired":true,"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX].description","typeLabel":"string"},"required":{"description":"Whether this evidence is mandatory for the defense.","type":"boolean","isRequired":true,"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX].required","typeLabel":"boolean"},"slug":{"description":"Machine-readable identifier for the evidence type.","type":"string","uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX].slug","typeLabel":"string"},"evidenceId":{"description":"ID of the uploaded evidence file.","type":"string","format":"uuid","uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX].evidenceId","typeLabel":"string\u003cuuid>"},"evidenceInfo":{"description":"Display metadata for the already-uploaded evidence file, present when evidenceId is set.","type":"object","properties":{"displayTitle":{"description":"Human-readable file name or title of the uploaded evidence.","type":"string","uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX].evidenceInfo.displayTitle","typeLabel":"string"},"contentType":{"description":"MIME type of the uploaded evidence file.","type":"string","uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX].evidenceInfo.contentType","typeLabel":"string"},"contentLength":{"description":"Size of the uploaded evidence file in bytes.","type":"integer","uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX].evidenceInfo.contentLength","typeLabel":"integer"}},"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX].evidenceInfo","typeLabel":"object"}},"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX].options","typeLabel":"object[]"}},"uniqueKey":"representmentPlan.defenseReasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"representmentPlan.defenseReasons","typeLabel":"object[]"},"assessment":{"description":"Win likelihood of the selected defense. Omitted when AI drafting is off, the plan recommends accepting, or no defense is selected.","type":"object","required":["status","likelihood"],"properties":{"status":{"description":"Whether the assessment can be shown. Always `ready`, as the assessment is computed on each read.","type":"string","enum":["ready"],"isRequired":true,"uniqueKey":"representmentPlan.assessment.status","typeLabel":"enum\u003cstring>"},"likelihood":{"type":"object","required":["current"],"properties":{"current":{"description":"Band with the evidence attached now.","type":"string","enum":["low","medium","high"],"isRequired":true,"uniqueKey":"representmentPlan.assessment.likelihood.current","typeLabel":"enum\u003cstring>"},"projected":{"description":"Band if all missing required evidence were attached. Omitted when equal to current.","type":"string","enum":["low","medium","high"],"uniqueKey":"representmentPlan.assessment.likelihood.projected","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"representmentPlan.assessment.likelihood","typeLabel":"object"},"missing":{"description":"Required evidence no file covers, in plan order. Once the draft has a text section, only files a section links count. Omitted when none is missing.","type":"array","items":{"type":"object","required":["evidenceSlug"],"properties":{"evidenceSlug":{"description":"Slug of the required evidence option.","type":"string","isRequired":true,"uniqueKey":"representmentPlan.assessment.missing.items.[INDEX].evidenceSlug","typeLabel":"string"},"sectionId":{"description":"ID of the text section the evidence belongs in. Omitted when no section fits.","type":"string","format":"uuid","uniqueKey":"representmentPlan.assessment.missing.items.[INDEX].sectionId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"representmentPlan.assessment.missing.items.[INDEX]","typeLabel":"object"},"uniqueKey":"representmentPlan.assessment.missing","typeLabel":"object[]"},"uncited":{"description":"Evidence a text section links but its text does not cite, in document order. Omitted when there is none.","type":"array","items":{"type":"object","required":["sectionId","evidenceId"],"properties":{"sectionId":{"description":"ID of the text section.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"representmentPlan.assessment.uncited.items.[INDEX].sectionId","typeLabel":"string\u003cuuid>"},"evidenceId":{"description":"ID of the evidence the section links.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"representmentPlan.assessment.uncited.items.[INDEX].evidenceId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"representmentPlan.assessment.uncited.items.[INDEX]","typeLabel":"object"},"uniqueKey":"representmentPlan.assessment.uncited","typeLabel":"object[]"},"unsupported":{"description":"Sentences in a text section's stored text that no evidence backs, in document order. A sentence drops off once it is cited or edited. Omitted when there is none.","type":"array","items":{"type":"object","required":["sectionId","excerpt"],"properties":{"sectionId":{"description":"ID of the text section.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"representmentPlan.assessment.unsupported.items.[INDEX].sectionId","typeLabel":"string\u003cuuid>"},"excerpt":{"description":"The sentence exactly as it appears in the section text.","type":"string","isRequired":true,"uniqueKey":"representmentPlan.assessment.unsupported.items.[INDEX].excerpt","typeLabel":"string"}},"uniqueKey":"representmentPlan.assessment.unsupported.items.[INDEX]","typeLabel":"object"},"uniqueKey":"representmentPlan.assessment.unsupported","typeLabel":"object[]"}},"uniqueKey":"representmentPlan.assessment","typeLabel":"object"}},"uniqueKey":"representmentPlan","typeLabel":"object"},"representmentSections":{"description":"Ordered representment sections for this dispute.","type":"array","items":{"type":"object","required":["id","disputeId","createdAt","updatedAt","position","indent","sectionType"],"properties":{"id":{"description":"Unique identifier of the representment section in Payrails.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"disputeId":{"description":"Unique identifier of the dispute in Payrails.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].disputeId","typeLabel":"string\u003cuuid>"},"createdAt":{"description":"Date and time when the representment section was created in Payrails.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"Date and time when the representment section was last updated in Payrails.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"position":{"description":"Position of the section in the representment.","type":"integer","isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].position","typeLabel":"integer"},"indent":{"description":"Indentation level of the section in the representment.","type":"integer","isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].indent","typeLabel":"integer"},"sectionType":{"type":"string","description":"Type of representment section.","enum":["Text","Picture","Timeline"],"isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].sectionType","typeLabel":"enum\u003cstring>"},"textSectionTitle":{"description":"Title of the text section when sectionType is Text.","type":"string","uniqueKey":"representmentSections.items.[INDEX].textSectionTitle","typeLabel":"string"},"textSectionContent":{"description":"Content of the text section when sectionType is Text.","type":"string","uniqueKey":"representmentSections.items.[INDEX].textSectionContent","typeLabel":"string"},"textSectionEvidenceIds":{"description":"Identifiers of the evidence the text section relies on, when sectionType is Text.","type":"array","items":{"type":"string","format":"uuid","uniqueKey":"representmentSections.items.[INDEX].textSectionEvidenceIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"representmentSections.items.[INDEX].textSectionEvidenceIds","typeLabel":"string\u003cuuid>[]"},"citations":{"description":"Evidence quotes the citation tags in the text section content refer to, when sectionType is Text.","type":"array","items":{"type":"object","required":["id","evidenceId","excerpt"],"properties":{"id":{"description":"Short identifier of the citation, unique within the section, such as c1. The section text refers to it with a citation tag like {{citation:c1}}.","type":"string","pattern":"^[A-Za-z0-9_-]{1,32}$","example":"c1","isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].citations.items.[INDEX].id","typeLabel":"string"},"evidenceId":{"description":"Identifier of the evidence the excerpt is quoted from.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].citations.items.[INDEX].evidenceId","typeLabel":"string\u003cuuid>"},"excerpt":{"description":"Quote from the evidence that supports the cited sentence, at most 200 characters. Longer quotes are cut. Empty when the evidence has no readable text.","type":"string","maxLength":200,"isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].citations.items.[INDEX].excerpt","typeLabel":"string"}},"uniqueKey":"representmentSections.items.[INDEX].citations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"representmentSections.items.[INDEX].citations","typeLabel":"object[]"},"pictureSectionEvidenceId":{"description":"Linked evidence identifier when sectionType is Picture.","format":"uuid","type":"string","uniqueKey":"representmentSections.items.[INDEX].pictureSectionEvidenceId","typeLabel":"string\u003cuuid>"},"pictureSectionLabel":{"description":"Label for the picture section when sectionType is Picture.","type":"string","uniqueKey":"representmentSections.items.[INDEX].pictureSectionLabel","typeLabel":"string"},"pictureSectionEvidenceLinks":{"description":"Links for downloading the picture section evidence file when sectionType is Picture.","type":"object","properties":{"download":{"oneOf":[{"type":"string","uniqueKey":"representmentSections.items.[INDEX].pictureSectionEvidenceLinks.download.oneOf.0","typeLabel":"string"},{"type":"object","description":"Link related information.","required":["href"],"properties":{"href":{"type":"string","isRequired":true,"uniqueKey":"representmentSections.items.[INDEX].pictureSectionEvidenceLinks.download.oneOf.1.href","typeLabel":"string"},"method":{"type":"string","description":"HTTP method that should be used to call the `href`.","enum":["GET","POST","PUT","PATCH","DELETE"],"uniqueKey":"representmentSections.items.[INDEX].pictureSectionEvidenceLinks.download.oneOf.1.method","typeLabel":"enum\u003cstring>"}},"uniqueKey":"representmentSections.items.[INDEX].pictureSectionEvidenceLinks.download.oneOf.1","typeLabel":"object"}],"uniqueKey":"representmentSections.items.[INDEX].pictureSectionEvidenceLinks.download","typeLabel":"string | object"}},"uniqueKey":"representmentSections.items.[INDEX].pictureSectionEvidenceLinks","typeLabel":"object"}},"uniqueKey":"representmentSections.items.[INDEX]","typeLabel":"object"},"uniqueKey":"representmentSections","typeLabel":"object[]"},"representmentExhibits":{"description":"Evidence embedded in the representment PDF, in exhibit order, computed from the current sections rather than the last generated PDF. Only present when includeRepresentmentSections=true.","type":"array","items":{"type":"object","description":"An evidence embedded in the representment PDF.","required":["evidenceId","exhibitNumber"],"properties":{"evidenceId":{"description":"ID of the embedded evidence.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"representmentExhibits.items.[INDEX].evidenceId","typeLabel":"string\u003cuuid>"},"exhibitNumber":{"description":"Exhibit number shown in the PDF and its citations, starting at 1.","type":"integer","minimum":1,"isRequired":true,"uniqueKey":"representmentExhibits.items.[INDEX].exhibitNumber","typeLabel":"integer"}},"uniqueKey":"representmentExhibits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"representmentExhibits","typeLabel":"object[]"},"representmentPlanStatus":{"type":"string","description":"Status of the representment plan lifecycle.","enum":["GeneratingPlan","PlanReady","StoringEvidences","LabelingEvidences","Failed","EvidencesReady","GeneratingRepresentment","RepresentmentReady","Submitted"],"uniqueKey":"representmentPlanStatus","typeLabel":"enum\u003cstring>"},"tags":{"description":"Tags attached to this dispute.","type":"array","items":{"type":"object","required":["id","name","slug","color","type","typeId","cardinality","createdAt","updatedAt"],"properties":{"id":{"description":"Unique identifier of the Tag.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"tags.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"description":"Human-readable display name of the Tag.","type":"string","isRequired":true,"uniqueKey":"tags.items.[INDEX].name","typeLabel":"string"},"slug":{"description":"URL-safe identifier derived from the Tag name.","type":"string","isRequired":true,"uniqueKey":"tags.items.[INDEX].slug","typeLabel":"string"},"color":{"description":"Hex color code used to render the Tag (e.g. \"#EF4444\").","type":"string","isRequired":true,"uniqueKey":"tags.items.[INDEX].color","typeLabel":"string"},"type":{"description":"Tag type slug. Determines cardinality and grouping (e.g. \"merchant_status\", \"default\").","type":"string","isRequired":true,"uniqueKey":"tags.items.[INDEX].type","typeLabel":"string"},"typeId":{"description":"UUID of the tag_types row this tag belongs to.","type":"string","format":"uuid","isRequired":true,"uniqueKey":"tags.items.[INDEX].typeId","typeLabel":"string\u003cuuid>"},"cardinality":{"description":"Whether multiple tags of this type can be attached to the same dispute at once. `single` means at most one tag of this type per dispute; `multi` allows many.\n","type":"string","enum":["single","multi"],"isRequired":true,"uniqueKey":"tags.items.[INDEX].cardinality","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"Date and time when the Tag was created.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"tags.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"Date and time when the Tag was last updated.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"tags.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"workspaceId":{"oneOf":[{"description":"Workspace the Tag belongs to. Null for org-level tags visible to all workspaces.","type":"string","format":"uuid","uniqueKey":"tags.items.[INDEX].workspaceId.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Workspace the Tag belongs to. Null for org-level tags visible to all workspaces.","type":"null","format":"uuid","uniqueKey":"tags.items.[INDEX].workspaceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags.items.[INDEX].workspaceId","typeLabel":"string\u003cuuid> | null"},"description":{"oneOf":[{"description":"Optional description of the Tag.","type":"string","uniqueKey":"tags.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the Tag.","type":"null","uniqueKey":"tags.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags.items.[INDEX].description","typeLabel":"string | null"},"deletedAt":{"oneOf":[{"description":"Date and time when the Tag was soft-deleted. Null if active.","type":"string","format":"date-time","uniqueKey":"tags.items.[INDEX].deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Date and time when the Tag was soft-deleted. Null if active.","type":"null","format":"date-time","uniqueKey":"tags.items.[INDEX].deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags.items.[INDEX].deletedAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tags","typeLabel":"object[]"},"evidenceClassifications":{"description":"AI classifications for the evidences associated with this dispute.\nOnly present when includeEvidenceClassifications=true.","type":"array","items":{"type":"object","required":["evidenceId","disputeId","status"],"properties":{"evidenceId":{"description":"Unique identifier of the evidence file that was classified.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"evidenceClassifications.items.[INDEX].evidenceId","typeLabel":"string\u003cuuid>"},"disputeId":{"description":"Unique identifier of the dispute the evidence belongs to.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"evidenceClassifications.items.[INDEX].disputeId","typeLabel":"string\u003cuuid>"},"status":{"description":"Classification status.","type":"string","enum":["classifying","classified","failed"],"isRequired":true,"uniqueKey":"evidenceClassifications.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"contentSummary":{"description":"AI-generated summary of the evidence file content.","type":"string","uniqueKey":"evidenceClassifications.items.[INDEX].contentSummary","typeLabel":"string"},"documentType":{"description":"AI-inferred document type (e.g. \"receipt\", \"shipping_label\").","type":"string","uniqueKey":"evidenceClassifications.items.[INDEX].documentType","typeLabel":"string"},"provesStatement":{"description":"AI-generated statement of what the evidence proves in the dispute context.","type":"string","uniqueKey":"evidenceClassifications.items.[INDEX].provesStatement","typeLabel":"string"},"keyFacts":{"description":"List of key facts extracted from the evidence.","type":"array","items":{"type":"string","uniqueKey":"evidenceClassifications.items.[INDEX].keyFacts.items.[INDEX]","typeLabel":"string"},"uniqueKey":"evidenceClassifications.items.[INDEX].keyFacts","typeLabel":"string[]"},"suggestedPlanMatches":{"description":"Representment plan slots this evidence is suggested to fill, ordered by confidence.","type":"array","items":{"type":"object","required":["defenseReasonCode","slug","position","rationale"],"properties":{"defenseReasonCode":{"description":"Defense reason code of the plan slot this evidence matches.","type":"string","isRequired":true,"uniqueKey":"evidenceClassifications.items.[INDEX].suggestedPlanMatches.items.[INDEX].defenseReasonCode","typeLabel":"string"},"slug":{"description":"Slug identifier of the matching plan evidence slot.","type":"string","isRequired":true,"uniqueKey":"evidenceClassifications.items.[INDEX].suggestedPlanMatches.items.[INDEX].slug","typeLabel":"string"},"position":{"description":"Position of the matching slot within the defense type.","type":"integer","isRequired":true,"uniqueKey":"evidenceClassifications.items.[INDEX].suggestedPlanMatches.items.[INDEX].position","typeLabel":"integer"},"rationale":{"description":"AI-generated explanation for why this evidence matches the slot.","type":"string","isRequired":true,"uniqueKey":"evidenceClassifications.items.[INDEX].suggestedPlanMatches.items.[INDEX].rationale","typeLabel":"string"}},"uniqueKey":"evidenceClassifications.items.[INDEX].suggestedPlanMatches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"evidenceClassifications.items.[INDEX].suggestedPlanMatches","typeLabel":"object[]"},"providerResponseId":{"description":"Identifier of the LLM provider response that produced this classification.","type":"string","uniqueKey":"evidenceClassifications.items.[INDEX].providerResponseId","typeLabel":"string"},"createdAt":{"description":"Date and time when the classification was created.","format":"date-time","type":"string","uniqueKey":"evidenceClassifications.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"Date and time when the classification was last updated.","format":"date-time","type":"string","uniqueKey":"evidenceClassifications.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"evidenceClassifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"evidenceClassifications","typeLabel":"object[]"},"defenseSubmission":{"description":"Status of the asynchronous defense submission.","type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["Submitting","Submitted","Failed"],"description":"Current submission status.","isRequired":true,"uniqueKey":"defenseSubmission.status","typeLabel":"enum\u003cstring>"},"detail":{"type":"string","description":"Submission failure details.","uniqueKey":"defenseSubmission.detail","typeLabel":"string"}},"uniqueKey":"defenseSubmission","typeLabel":"object"},"evidenceSubmission":{"description":"Status of the asynchronous evidence submission.","type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["Submitting","Submitted","Failed"],"description":"Current submission status.","isRequired":true,"uniqueKey":"evidenceSubmission.status","typeLabel":"enum\u003cstring>"},"detail":{"type":"string","description":"Submission failure details.","uniqueKey":"evidenceSubmission.detail","typeLabel":"string"}},"uniqueKey":"evidenceSubmission","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","providerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","providerConfigId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","providerReference":"\u003cstring>","stage":"Created","amount":{"value":"12.50","currency":"EUR"},"applicableDefenseReasons":[{"providerReasonCode":"\u003cstring>","title":"\u003cstring>","description":"\u003cstring>","evidenceTypes":[{"providerTypeCode":"\u003cstring>","title":"\u003cstring>","description":"\u003cstring>"}]}],"assignedToUserId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","assignedToUserEmail":"\u003cstring>","channel":"Provider","chargebackStatus":"Incoming","defenseStatus":"NotDefendable","defensePeriodExpiresAt":"2023-11-07T05:31:56Z","providerCreatedAt":"2023-11-07T05:31:56Z","merchantReference":"\u003cstring>","paymentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","workspaceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","executionId":"\u003cstring>","reason":"\u003cstring>","reasonCode":"\u003cstring>","schemeReasonCode":"\u003cstring>","issuerComments":{},"liabilityShifted":true,"payment":{"status":"Created","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","providerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","providerName":"\u003cstring>","providerDisplayName":"\u003cstring>","providerReference":"\u003cstring>","providerConfigId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","providerIntegrationType":"\u003cstring>","paymentMethodType":"\u003cstring>","holderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","holderReference":"\u003cstring>","amount":{"value":"12.50","currency":"EUR"},"merchantReference":"\u003cstring>","acquirerReference":"74537604221431003881865","workspaceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","instrument":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","holderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","paymentMethod":"alexBankMa7fazty","status":"created","displayName":"\u003cstring>","description":"\u003cstring>","default":true,"merchantReference":"\u003cstring>","fingerprint":"\u003cstring>","futureUsage":"Subscription","networkTransactionReference":"\u003cstring>","transactionLinkId":"\u003cstring>","data":{"network":"unspecified","bin":"416598","suffix":"\u003cstring>","preferredScheme":"unspecified","binLookup":{"bin":"416598","network":"unspecified","localNetwork":"bancontact","issuer":"\u003cstring>","issuerCountry":{"code":"\u003cstring>","iso3":"\u003cstring>","name":"\u003cstring>"},"segment":"\u003cstring>","type":"\u003cstring>","typeDetails":"\u003cstring>","isNetworkToken":true,"isFlexCard":true},"billingAddress":{"street":"\u003cstring>","doorNumber":"\u003cstring>","complement":"\u003cstring>","area":"\u003cstring>","city":"\u003cstring>","postalCode":"\u003cstring>","state":"\u003cstring>","country":{"code":"\u003cstring>","iso3":"\u003cstring>","name":"\u003cstring>"},"latitude":123,"longitude":123,"phone":{"number":"\u003cstring>","countryCode":"\u003cstring>"},"alias":"\u003cstring>","name":"\u003cstring>","lastName":"\u003cstring>","email":"\u003cstring>"},"expiryMonth":"\u003cstring>","expiryYear":"\u003cstring>","holderName":"\u003cstring>","taxId":"\u003cstring>"}},"meta":{"order":{},"customer":{},"clientContext":{},"vendor":{},"risk":{},"subscription":{},"tags":{},"paymentMethods":{},"upi":"\u003cunknown>"}},"evidences":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","displayTitle":"\u003cstring>","status":"Active","provenance":"Merchant","contentType":"\u003cstring>","contentLength":123,"payload":{},"documentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","version":123,"validFrom":"2023-11-07T05:31:56Z","changeNote":"\u003cstring>","workspaceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","labels":["\u003cstring>"],"submitted":true,"sentToProviderAt":"2023-11-07T05:31:56Z","exhibit":{"kind":"transaction","source":"\u003cstring>","reading":"\u003cstring>","writtenBy":"ai","updatedAt":"2023-11-07T05:31:56Z"}}],"submittedEvidences":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","displayTitle":"\u003cstring>","status":"Active","provenance":"Merchant","contentType":"\u003cstring>","contentLength":123,"payload":{},"documentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","version":123,"validFrom":"2023-11-07T05:31:56Z","changeNote":"\u003cstring>","workspaceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","labels":["\u003cstring>"],"submitted":true,"sentToProviderAt":"2023-11-07T05:31:56Z","exhibit":{"kind":"transaction","source":"\u003cstring>","reading":"\u003cstring>","writtenBy":"ai","updatedAt":"2023-11-07T05:31:56Z"}}],"representmentPlan":{"disputeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","status":"GeneratingPlan","providerResponseId":"\u003cstring>","lastSectionGeneration":{"succeeded":true,"completedAt":"2023-11-07T05:31:56Z"},"recommendation":"\u003cstring>","rationale":"\u003cstring>","defenseReasons":[{"code":"\u003cstring>","title":"\u003cstring>","description":"\u003cstring>","selected":true,"options":[{"position":123,"title":"\u003cstring>","description":"\u003cstring>","required":true,"slug":"\u003cstring>","evidenceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","evidenceInfo":{"displayTitle":"\u003cstring>","contentType":"\u003cstring>","contentLength":123}}]}],"assessment":{"status":"ready","likelihood":{"current":"low","projected":"low"},"missing":[{"evidenceSlug":"\u003cstring>","sectionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"uncited":[{"sectionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","evidenceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"unsupported":[{"sectionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","excerpt":"\u003cstring>"}]}},"representmentSections":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","disputeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","position":123,"indent":123,"sectionType":"Text","textSectionTitle":"\u003cstring>","textSectionContent":"\u003cstring>","textSectionEvidenceIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"citations":[{"id":"c1","evidenceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","excerpt":"\u003cstring>"}],"pictureSectionEvidenceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","pictureSectionLabel":"\u003cstring>","pictureSectionEvidenceLinks":{"download":"\u003cstring>"}}],"representmentExhibits":[{"evidenceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","exhibitNumber":2}],"representmentPlanStatus":"GeneratingPlan","tags":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","slug":"\u003cstring>","color":"\u003cstring>","type":"\u003cstring>","typeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","cardinality":"single","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","workspaceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","description":"\u003cstring>","deletedAt":"2023-11-07T05:31:56Z"}],"evidenceClassifications":[{"evidenceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","disputeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"classifying","contentSummary":"\u003cstring>","documentType":"\u003cstring>","provesStatement":"\u003cstring>","keyFacts":["\u003cstring>"],"suggestedPlanMatches":[{"defenseReasonCode":"\u003cstring>","slug":"\u003cstring>","position":123,"rationale":"\u003cstring>"}],"providerResponseId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}],"defenseSubmission":{"status":"Submitting","detail":"\u003cstring>"},"evidenceSubmission":{"status":"Submitting","detail":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"5095946f-16d3-4dee-a8f3-3e7b9db3d0df":{"description":"Submission accepted.","content":{"application/json":{"schema":{"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"exampleType":"generated"},"43d6ecb5-89f9-40e4-9bb3-756b09941757":{"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"},"f8cfd1ff-6db8-468e-8c7d-5e4824ba5b61":{"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"},"b65bbb12-f351-478b-926f-1e2638416c85":{"description":"Forbidden.","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"},"0b26eae1-b8c1-4cc4-80d5-6f44085cbedd":{"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"},"c8a23794-8e2e-435a-af36-3fdcdbab9622":{"description":"Conflict.","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.conflict","detail":"The request operation is not allowed due to a conflict with the current state of the resource","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestconflict"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"request.conflict","detail":"The request operation is not allowed due to a conflict with the current state of the resource","docUrl":"https://docs.payrails.com/docs/resources/error-codes#requestconflict"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"efa55d10-a739-4ebb-bb9e-795f0f8abfbe":{"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"},"9b1a4caa-f7f2-4e31-ac94-2e5ad0dd2be2":{"description":"Internal Server Error.","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":"internal","detail":"An internal error occurred","docUrl":"https://docs.payrails.com/docs/resources/error-codes#internal"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"id":"a24bc325-3929-4d9d-9c08-b3aa532685b7","code":"internal","detail":"An internal error occurred","docUrl":"https://docs.payrails.com/docs/resources/error-codes#internal"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"b92b6c50-4d24-484c-b095-2f4d743290b0":{"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":["disputes:defend"],"schemeName":"BearerToken"}}},"servers":{"302dfc45-eef0-43da-a66e-60e8bf886c1e":{"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":["disputes:defend"],"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":"Defend a Dispute - Payrails Docs","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"reference/defenddispute.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=\"Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated dispute.\">\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=\"Defend a Dispute - Payrails Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated dispute.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Payrails Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payrails.com/reference/defenddispute\">\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=Disputes\u0026amp;title=Defend+a+Dispute\u0026amp;description=Defend+a+dispute+by+sending+evidence+files%2C+a+type+code+per+file%2C+and+a+provider+reason+code+to+the+payment+provider%2C+and+get+the+updated+dispute.\u0026amp;theme=fc36d2d43704e46c9451c8d9\u0026amp;signature=07529c17a70aa22965210b13e8bc6d5e368c3acd9e4f2664bb30a58f809d3ce7\">\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=\"Defend a Dispute - Payrails Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated dispute.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://payrails-42074109.mintlify.site/_mintlify/api/og/v2?division=Disputes\u0026amp;title=Defend+a+Dispute\u0026amp;description=Defend+a+dispute+by+sending+evidence+files%2C+a+type+code+per+file%2C+and+a+provider+reason+code+to+the+payment+provider%2C+and+get+the+updated+dispute.\u0026amp;theme=fc36d2d43704e46c9451c8d9\u0026amp;signature=07529c17a70aa22965210b13e8bc6d5e368c3acd9e4f2664bb30a58f809d3ce7\">\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/defenddispute\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/defenddispute.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/defenddispute#webpage\",\"url\":\"https://docs.payrails.com/reference/defenddispute\",\"name\":\"Defend a Dispute\",\"description\":\"Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated dispute.\",\"isPartOf\":{\"@id\":\"https://docs.payrails.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.payrails.com/reference/defenddispute#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.payrails.com/reference/defenddispute#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Dispute\",\"item\":\"https://docs.payrails.com/reference/listdisputes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Disputes\",\"item\":\"https://docs.payrails.com/reference/listdisputes\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Defend a Dispute\",\"item\":\"https://docs.payrails.com/reference/defenddispute\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.payrails.com/reference/defenddispute#apireference\",\"headline\":\"Defend a Dispute\",\"name\":\"Defend a Dispute\",\"description\":\"Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated dispute.\",\"url\":\"https://docs.payrails.com/reference/defenddispute\",\"mainEntityOfPage\":{\"@id\":\"https://docs.payrails.com/reference/defenddispute#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/defenddispute.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","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","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","description":"Retrieve a dispute by ID, using include parameters to add its payment, instrument, evidence files, representment plan, and sections in one response.","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","description":"Accept a dispute without submitting a defense to concede the chargeback, and see whether the provider processed it along with the new defense status.","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":"Defend a Dispute - Payrails Docs","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}