> ## Documentation Index > Fetch the complete documentation index at: https://docs.payrails.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent 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. # Search & list events > Search & list a workflow execution event history. ## OpenAPI ````yaml https://cdn.payrails.io/docs/api/openapi.min.json?nav=workflow get /merchant/workflows/{workflowCode}/executions/{executionId}/history openapi: 3.1.0 info: version: 1.3.15 title: Payrails API Reference contact: name: Payrails url: https://www.payrails.com email: tech@payrails.com license: name: Payrails GmbH url: https://www.payrails.com/ description: > --- Payrails provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library. servers: - url: https://api.staging.payrails.io description: Payrails environment. security: - ApiKey: [] tags: - name: 3D Secure description: Operations to monitor 3DS operations. - name: Actions description: >- A workflow execution action is a predefined interaction that can be triggered to change the state of the workflow execution. For example authorizing or refunding a payment. - name: API Logs description: API Logs. - name: Authentication description: >- Payrails API is secured via [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) industry-standard protocol for authorization. Server-side requests are authenticated using a [Bearer Token](https://datatracker.ietf.org/doc/html/rfc6750) in the request `Authorization` header. - name: BIN Lookup description: >- Operations related to getting information about a card by its BIN (or IIN). - name: Client description: Endpoints used by our client-side SDK. - name: Disputes description: Operations to managing disputes. - name: Drop-in Links description: >- Create and manage drop-in payment links that can be shared with payers. Drop-in links support full or partial payments, define the total amount and expiration, and return a public URL that merchants can send to customers. - name: Executions description: >- A workflow execution is an act of performing a set of tasks that are defined in the [Workflow](/api-reference/reference/#operation/listDefaultWorkflows) such as accepting payments. - name: Files description: Operations related to files processing - name: Fraud Checks description: >- A Fraud check Payrails is a collection of operations over time, that is created by a workflow execution and followed by the workflow actions. In this section, you can list all the fraud entities or a single one to learn about the details of involved instruments, providers, statuses, decisions and more. - name: Holders description: >- A Holder is a group of accounts that belong together with specific criteria, linked to their payment instruments and identities. For example, it can represent a digital wallet for a person, where they store balance that they top up, refunded orders, referral bonuses, etc. - name: Instrument Tokens description: >- Tokens are representations of our payment instruments in external providers. One payment instrument can have many tokens, because we keep the mapping in each external provider that knows about it. For example, the same real life card can have a token in our Vault, but also in Adyen and Checkout PSPs. - name: Instruments description: >- Payment instruments are specific instances of a payment method that belong to the holder executing the workflow. They can be a previously stored card, a new card that was typed in a form, a phone number, an IBAN, or some way to fetch an account in a provider (like PayPal or AliPay). - name: Payments description: >- A [Payment](/guides/whats-payrails/payments/) in Payrails is a collection of operations over time, that is created by a workflow execution and followed by the workflow actions. In this section, you can list all the payments or a single one to learn about the details of involved payment methods, instruments, providers, statuses and more. - name: Payouts description: Payouts are money movements paid to an external party. - name: Provider Configs description: Operations related to managing configurations for Providers. - name: Providers description: Operations related to managing Providers. - name: Reconciliation Records description: >- Operations to retrieve reconciliation record aggregates, transactions, and reconciliation metadata. - name: Report Runs description: Operations to generate and retrieve report runs. - name: Reports description: Operations to see available reports. - name: Rulesets description: Operations related to managing Rulesets. - name: SSO Connections description: Operations related to managing SSO identity provider connections. - name: Vault Display SDK description: Operations related to DisplaySDK. - name: Vault Instant Proxy description: Operations related to Instant Proxy API requests. - name: Vault Proxy Connections description: Operations related to managing token connections. - name: Vault Public Encryption description: Public endpoints related to encryption. - name: Vault Records and Aliases description: Operations related to managing records and aliases. - name: Workflows description: >- Any operation in Payrails is defined and executed with a [Workflow](/guides/whats-payrails/workflow/) that is configured for a particular use-case of the merchant. The workflow configurations support versioning. - name: Workspaces description: Operations related to managing workspaces. paths: /merchant/workflows/{workflowCode}/executions/{executionId}/history: get: tags: - Actions summary: Search & list events description: Search & list a workflow execution event history. operationId: getWorkflowHistory parameters: - name: workflowCode in: path description: Path parameter to specify the workflow code. required: true schema: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. example: payment-acceptance - name: executionId in: path description: Identifier of the resource in Payrails. required: true schema: type: string format: uuid example: d5454c2f-ae5e-44f3-8edf-f6dad64f005f - name: filter[event] in: query schema: type: string description: Name of the event. enum: - executionCreated - executionActionRequested - executionActionCompleted - ruleEngineExecuted - networkOffersEnrollmentCompleted - executionActionScheduled - executionActionUnscheduled - executionActionUpdated - executionActionPending - executionActionStepScheduled - executionActionStepUnscheduled - executionActionStepRequested - executionActionStepStarted - executionActionStepPaused - executionActionStepResumed - executionActionStepCompleted - executionActionStepUpdated - executionTriggerStepCalled - executionConditionStepEvaluated description: Filter for the type of event. - name: filter[action] in: query schema: type: string enum: - lookup - startPaymentSession - authorize - capture - confirm - cancel - refund description: Type of action. description: Filter for the type of action. - name: filter[actionId] in: query schema: type: string format: uuid description: >- Filter for the unique action execution identifier originally returned in the synchronous action response. - name: filter[notificationStatus] in: query schema: type: string description: Value of Notification event status enumeration. enum: - delivered - deliveryFailed - pending description: Filter for the status of the associated notification event. - name: filter[errorCode] in: query schema: type: string description: Filter for the type of error code produced for execution event. responses: '200': description: OK. content: application/json: schema: type: object required: - events properties: events: type: array items: type: object description: >- Workflow event history record with related notifications. required: - event - time - details - workspaceId - eventTrigger properties: event: type: string description: Name of the event. enum: - executionCreated - executionActionRequested - executionActionCompleted - ruleEngineExecuted - networkOffersEnrollmentCompleted - executionActionScheduled - executionActionUnscheduled - executionActionUpdated - executionActionPending - executionActionStepScheduled - executionActionStepUnscheduled - executionActionStepRequested - executionActionStepStarted - executionActionStepPaused - executionActionStepResumed - executionActionStepCompleted - executionActionStepUpdated - executionTriggerStepCalled - executionConditionStepEvaluated time: type: string format: date-time description: When this execution was started. details: type: object description: >- Workflow event details. Sensitive information in the details is masked. anyOf: - type: object title: executionCreated description: Details for an executionCreated event. required: - request - response properties: request: type: object title: The request used to create the execution. required: - merchantReference - holderReference properties: merchantReference: type: string description: >- Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system. holderReference: type: string description: >- Merchant-provided reference for the execution counterparty, i.e. the paying consumer. workspaceId: type: string description: >- References in which workspace the execution will be created. workflowConfigOverride: description: >- Merchant-provided configuration data for a particular execution, overriding values for the workflow. type: object properties: captureMode: type: string description: > Mode of capture for the payments involved in the execution. * `Instant` - Authorize and capture payments in one step. * `Delayed` - Authorize payments initially, capture the money after a delay configured with `captureDelay`. * `Manual` - Authorize payments initially, capture the money manually via Payrails' API or portal. enum: - Instant - Delayed - Manual captureDelay: type: string description: >- If `captureMode` is `Delayed`, this field can be used to configure the scheduled time when to capture the money. The format should be based on the [ISO 8601 standard](https://tc39.es/proposal-temporal/docs/duration.html). cancelMode: type: string description: > Mode of cancel for the payments involved in the execution. * `Delayed` - Authorize payments initially, cancel the authorization after a delay configured with `cancelDelay`. * `Manual` - Authorize payments initially, cancel the authorization manually via Payrails' API or portal. enum: - Delayed - Manual cancelDelay: type: string description: >- If `cancelMode` is `Delayed`, this field can be used to configure the scheduled time when to cancel the authorization. The format should be based on the [ISO 8601 standard](https://tc39.es/proposal-temporal/docs/duration.html). workflowVersion: type: integer description: Version of a Workflow Configuration. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. applePayConfigId: type: string description: >- ID of the Apple Pay configuration to use for this request. When provided, Apple Pay will be enabled as a payment method. initialActions: description: >- Actions to execute after the creation of the execution. Initial actions are performed sequentially, and results reported in corresponding items of `initialResults` irrespective of errors in earlier actions. type: array items: anyOf: - type: object title: Initial Lookup action. required: - action properties: action: type: string enum: - lookup description: Execute an initial lookup action. method: type: string enum: - POST body: type: object properties: 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. - type: object title: Initial Start Payment Session action. required: - action - method - body properties: action: type: string enum: - startPaymentSession description: >- Execute an initial start payment session action. method: type: string enum: - POST body: type: object required: - integrationType - amount properties: integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. paymentMethodCode: type: string enum: - applePay description: >- Code of the payment method selected to start a payment session. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. returnInfo: type: object description: > URLs from the merchant side where the consumer should be taken after a redirection flow. If no specific flow for `cancel` or `error` are needed, we will redirect to the value in the `success` URL. The 'pending' URL is used in case the consumer needs to be redirected back to a page if an execution stays in pending for some time. required: - success properties: success: type: string description: >- URL to redirect consumers to when the execution stops interacting with them due to progress. cancel: type: string description: >- URL to redirect consumers to when the execution is canceled. error: type: string description: >- URL to redirect consumers to when the execution encounters technical difficulties. pending: type: string description: >- URL to redirect consumers to when the execution stays in pending for some time. meta: description: >- Any merchant-specific data that should be used and carried for context in the action execution. anyOf: - title: General 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. - title: Apple Pay type: object required: - sessionURL properties: sessionURL: type: string description: >- Validation URL provided by Apple Pay client. - type: object title: Initial Payment Authorize action. required: - action - method - body properties: action: type: string enum: - authorize description: >- Execute an initial payment authorize action. method: type: string enum: - POST body: type: object required: - amount - returnInfo - paymentComposition properties: 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: The amount to authorize. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. returnInfo: type: object description: > URLs from the merchant side where the consumer should be taken after a redirection flow. If no specific flow for `cancel` or `error` are needed, we will redirect to the value in the `success` URL. The 'pending' URL is used in case the consumer needs to be redirected back to a page if an execution stays in pending for some time. required: - success properties: success: type: string description: >- URL to redirect consumers to when the execution stops interacting with them due to progress. cancel: type: string description: >- URL to redirect consumers to when the execution is canceled. error: type: string description: >- URL to redirect consumers to when the execution encounters technical difficulties. pending: type: string description: >- URL to redirect consumers to when the execution stays in pending for some time. paymentComposition: description: >- Selected composition of payments methods and instruments to execute the action. We support one payment for each Workflow for now. Split payments and multiple payments in a Workflow will be supported very soon. type: array items: type: object minItems: 1 maxItems: 1 required: - integrationType - amount properties: paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount to pay with this payment instrument or method. paymentInstrumentId: type: string format: uuid description: >- Unique identifier of the Payment Instrument that the customer selected for the Payment. paymentInstrumentData: type: object description: >- Map containing extra information collected in the client-side about the payment instrument, needed for processing the payment on backend. additionalProperties: true properties: payerFields: type: object description: >- Values the payer supplied against the payment method's `clientConfig.instrumentDataSchema` from the lookup response, keyed and typed exactly as published there. Unknown keys and values of another type are rejected. Omit when the payment method is used through its redirect flow. additionalProperties: true example: phoneCountryCode: '351' phoneNumber: '912345678' paymentToken: type: string description: >- One-time payment token generated on client-side needed for execution of payment on backend (e.g. Google/Apple Pay). providerData: type: object additionalProperties: true description: >- Provider-specific data needed by to use the integration type for a payment (e.g. for Adyen Drop-in). nullable: true vaultToken: type: string description: >- Vault token generated on client-side needed for execution of payment on backend (e.g. Card). vaultProviderConfigId: type: string format: uuid nullable: true description: >- Vault provider configuration ID originally used to generate the vaultToken. card: type: object additionalProperties: true description: >- Card-specific data needed by to use the vault tokens (e.g. Card). nullable: true encryptedData: type: string description: > Encrypted instrument details. If `encryptedData` is passed without any instrument ID in the payment composition item, then instrument details are expected as part of the encrypted data. The instrument details will be used to tokenize the instrument. If `encryptedData` is passed with an instrument ID in the payment composition item, then only the security code is expected as part of the encrypted data. The security code will be updated for the instrument vault token and used for the authorization. The instrument details should be encrypted with the RSA public key provided by Payrails SDK using JWE with encryption algorithm RSA-OAEP-256 and content encryption A256CBC-HS512. Check the [tokenization guide](https://docs.payrails.com/docs/token-vault/tokenize-payment-instruments/tokenize-cards-with-client-side-encryption) for more information. nullable: true encryptedDataType: type: string enum: - card - networkToken description: >- Type of token provided in the encyrptedData. e.g. 'card' when tokenizing fpan, 'network token' when tokenizing dpan or network token. nullable: true futureUsage: nullable: true description: >- Only used if `encryptedData` is passed. Check the [Authorization Flags](https://docs.payrails.com/docs/resources/payments/authorization-flags) docs for how to use it. type: string enum: - Subscription - CardOnFile - UnscheduledCardOnFile merchantReference: nullable: true description: >- Merchant-provided reference for the instrument. Only used if `encryptedData` is passed. type: string billingAddress: nullable: true description: >- Merchant-provided billing address for the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. qrCode: type: string nullable: true description: >- QR Code provided on client-side and used to process a payment initiated by scanning a QR Code. eci: type: string description: >- The code indicating the result of the attempt to authenticate the cardholder. network: description: >- The card network of the encrypted instrument, e.g. Visa, Mastercard, American Express. type: string 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 preferredScheme: description: >- Selected card scheme to prefer when authorizing a co-badged card. type: string 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 displayName: type: string description: Instrument name suitable for display. default: type: boolean nullable: true description: >- Used to mark the new instrument as default. taxId: type: string description: >- Payer-provided tax identification number (e.g. CPF in Brazil) to store on the instrument. storeInstrument: type: boolean description: >- Flag indicating if the customer wants to store the Payment Instrument for using it in future executions. default: false enrollInstrumentToNetworkOffers: type: boolean description: >- Flag indicating if the customer wants to enroll a card to network offers program. If set to true, requires 'storeInstrument' to be true. default: false installments: type: object nullable: true description: > Indicates the payment needs to be made in installments. Should only be set if installments are supported in the region by the PSP and the payment method. During the validation of the request, if it is determined that installments is not supported, the request would fail with an error. additionalProperties: true properties: count: type: integer description: >- Number of installments in which the payment should be made. planReference: type: string description: >- Opaque plan handle, echoed from the selected plan. Send it whenever the plan carried one. totalAmount: type: number description: >- Total of the selected plan, echoed from the payment options response. requires: type: array description: >- Conditions the selected plan imposes, echoed from the payment options response. items: type: string enum: - threeDSecure - cardVerificationCode response: type: object title: >- The response to the create execution request. required: - id - status - createdAt - merchantReference - holderReference - holderId properties: id: type: string format: uuid description: ID of this execution. status: type: array description: >- Business-case dependent set of status tags of this execution. The order of statuses does not matter and should not be used for any logic. items: type: object required: - code - time properties: code: type: string description: Business-case dependent status code. time: type: string format: date-time description: When this execution status was set. errors: type: array description: >- The reason why the status was set, absent if the status isn't an error status. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. uniqueItems: true createdAt: type: string format: date-time description: When this execution was started. merchantReference: type: string description: >- Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system. example: order_15415 holderReference: type: string description: >- Merchant-provided reference for the transaction counterparty, i.e. the paying consumer. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: > Amount of the execution. Only present if an amount has been set on the execution via an action (lookup, authorize, etc.). 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. initialResults: description: > Results of the `initialActions` specified during execution creation. Indexes of this array correspond one to one with those from `initialActions`, each initial action reports their result here. type: array items: type: object title: An action response. required: - httpCode - body properties: httpCode: type: integer description: >- The HTTP code returned by the action invocation. body: anyOf: - title: Initial Lookup action result. allOf: - type: object required: - name - actionId - executedAt - links properties: name: type: string actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. workspaceId: type: string format: uuid description: >- Unique identifier of a workspace in Payrails. executedAt: type: string format: date-time description: >- Date and time when execution of the Action was started. links: type: object - type: object required: - data properties: name: type: string description: >- Lookup the available payment methods and instruments. enum: - lookup data: type: object description: Lookup action results. required: - paymentCompositionOptions properties: paymentCompositionOptions: type: array description: >- List of Payment Methods and Payment Instruments that can be used to complete the execution. items: type: object required: - integrationType - description properties: paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. providerCode: type: string description: >- Provider code for which the payment composition option is available. description: type: string description: Description of the Payment Method. providerData: type: object additionalProperties: true description: >- Provider-specific data needed by to use the payment method for a payment. paymentInstruments: type: array description: >- List of stored Payment Instruments for this Method that belong to the specified holder. By default, only includes the ones with status `Created` or `Enabled`. items: type: object allOf: - {} - {} clientConfig: type: object description: >- Contains information related to the payment method and integration type. properties: displayName: type: string description: The payment method name. supportsSaveInstrument: type: boolean description: >- Returns true if the payment method supports storing a payment instrument. supportsBillingInfo: type: boolean description: >- Returns true if the merchant wants to collect billing information during checkout and if this information is supported by the payment methods. flow: type: string description: >- Enum with values direct and redirect, direct is set only when a payment method does not require redirecting the end user to a provider page to proceed with authorization. additionalConfig: type: object description: >- Specific configuration needed for the payment method. instrumentDataSchema: type: object description: Schema for the payment method. supportsInstallments: type: boolean description: >- Returns true if the payment method supports paying in installments. installments: type: object description: >- Installment plans keyed by ISO 3166-1 alpha-2 country. Empty when no plans are available for this card and amount. additionalProperties: {} example: BR: {} links: type: object description: >- Links to the next possible actions that can be taken. required: - execution properties: execution: description: >- URL to fetch the current execution state. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE authorize: description: URL to authorize the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE startPaymentSession: description: URL to start a payment session. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE - title: >- Initial Start Payment Session action result. allOf: - type: object required: - name - actionId - executedAt - links properties: name: type: string actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. workspaceId: type: string format: uuid description: >- Unique identifier of a workspace in Payrails. executedAt: type: string format: date-time description: >- Date and time when execution of the Action was started. links: type: object - type: object required: - data properties: name: type: string description: >- Starts a payment session on a specific Provider. enum: - startPaymentSession data: type: object description: >- Provider-specific data needed to continue the payment session. additionalProperties: true links: type: object description: >- Links to the next possible actions that can be taken. required: - execution properties: execution: description: >- URL to fetch the current execution state. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE - title: Initial Payment Authorize action result. allOf: - type: object required: - name - actionId - executedAt - links properties: name: type: string actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. workspaceId: type: string format: uuid description: >- Unique identifier of a workspace in Payrails. executedAt: type: string format: date-time description: >- Date and time when execution of the Action was started. links: type: object - type: object properties: name: type: string description: Triggers the selected payments on PSP. enum: - authorize links: type: object description: >- Links to the next possible actions that can be taken. required: - execution - consumerWait - cancel properties: execution: description: >- URL to fetch the current execution state. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE consumerWait: description: >- URL the consumer can be redirected to until payment is complete. This endpoint will redirect the consumer as needed for 3DS or other PSP interactions. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE capture: description: URL to capture the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE cancel: description: URL to cancel the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE refund: description: URL to refund the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE workspaceId: type: string format: uuid description: >- Workspace ID that that this execution belongs to. links: type: object description: >- Links to the next possible actions that can be taken. required: - self properties: self: oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE lookup: oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE 3ds: oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE authorize: oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE startPaymentSession: oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE capture: oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE refund: oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE cancel: oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE priceBreakdown: oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE consumerWait: oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE confirm: type: object title: Link related information. required: - href allOf: - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE - type: object properties: action: type: object description: >- A prerequisite action, which needs to be executed prior calling the provided link. additionalProperties: true requiredAction: type: object description: >- Details of the next possible actions that can be taken. required: - type properties: type: type: string enum: - redirect - confirm - review - wait description: Type of the required action. subType: type: string enum: - merchant - client - internal description: Sub type of the required action. description: type: string description: Details of the required action. href: type: string description: URL to complete the required action. method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE clientConfig: type: object description: >- Details for the client to indicate how an action needs to be performed. properties: renderMode: type: string enum: - hidden description: >- Indicates the visibility of the action when being performed on the client. action: type: object description: >- Details of a prerequisite action, which needs to be executed prior calling the provided link. additionalProperties: true actionRequired: type: string enum: - 3ds - confirm description: >- Action the customer needs to take to move the Execution state. A link with the same name should be used to continue. - title: executionActionRequested type: object description: Details for an executionActionRequested event. required: - action - request - response properties: action: type: string enum: - lookup - startPaymentSession - authorize - capture - confirm - cancel - refund description: Type of action. actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. request: type: object title: The request used to request the action. anyOf: - type: object required: - amount - returnInfo - paymentComposition properties: 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: The amount to authorize. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. returnInfo: type: object description: > URLs from the merchant side where the consumer should be taken after a redirection flow. If no specific flow for `cancel` or `error` are needed, we will redirect to the value in the `success` URL. The 'pending' URL is used in case the consumer needs to be redirected back to a page if an execution stays in pending for some time. required: - success properties: success: type: string description: >- URL to redirect consumers to when the execution stops interacting with them due to progress. cancel: type: string description: >- URL to redirect consumers to when the execution is canceled. error: type: string description: >- URL to redirect consumers to when the execution encounters technical difficulties. pending: type: string description: >- URL to redirect consumers to when the execution stays in pending for some time. paymentComposition: description: >- Selected composition of payments methods and instruments to execute the action. We support one payment for each Workflow for now. Split payments and multiple payments in a Workflow will be supported very soon. type: array items: type: object minItems: 1 maxItems: 1 required: - integrationType - amount properties: paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount to pay with this payment instrument or method. paymentInstrumentId: type: string format: uuid description: >- Unique identifier of the Payment Instrument that the customer selected for the Payment. paymentInstrumentData: type: object description: >- Map containing extra information collected in the client-side about the payment instrument, needed for processing the payment on backend. additionalProperties: true properties: payerFields: type: object description: >- Values the payer supplied against the payment method's `clientConfig.instrumentDataSchema` from the lookup response, keyed and typed exactly as published there. Unknown keys and values of another type are rejected. Omit when the payment method is used through its redirect flow. additionalProperties: true example: phoneCountryCode: '351' phoneNumber: '912345678' paymentToken: type: string description: >- One-time payment token generated on client-side needed for execution of payment on backend (e.g. Google/Apple Pay). providerData: type: object additionalProperties: true description: >- Provider-specific data needed by to use the integration type for a payment (e.g. for Adyen Drop-in). nullable: true vaultToken: type: string description: >- Vault token generated on client-side needed for execution of payment on backend (e.g. Card). vaultProviderConfigId: type: string format: uuid nullable: true description: >- Vault provider configuration ID originally used to generate the vaultToken. card: type: object additionalProperties: true description: >- Card-specific data needed by to use the vault tokens (e.g. Card). nullable: true encryptedData: type: string description: > Encrypted instrument details. If `encryptedData` is passed without any instrument ID in the payment composition item, then instrument details are expected as part of the encrypted data. The instrument details will be used to tokenize the instrument. If `encryptedData` is passed with an instrument ID in the payment composition item, then only the security code is expected as part of the encrypted data. The security code will be updated for the instrument vault token and used for the authorization. The instrument details should be encrypted with the RSA public key provided by Payrails SDK using JWE with encryption algorithm RSA-OAEP-256 and content encryption A256CBC-HS512. Check the [tokenization guide](https://docs.payrails.com/docs/token-vault/tokenize-payment-instruments/tokenize-cards-with-client-side-encryption) for more information. nullable: true encryptedDataType: type: string enum: - card - networkToken description: >- Type of token provided in the encyrptedData. e.g. 'card' when tokenizing fpan, 'network token' when tokenizing dpan or network token. nullable: true futureUsage: nullable: true description: >- Only used if `encryptedData` is passed. Check the [Authorization Flags](https://docs.payrails.com/docs/resources/payments/authorization-flags) docs for how to use it. type: string enum: - Subscription - CardOnFile - UnscheduledCardOnFile merchantReference: nullable: true description: >- Merchant-provided reference for the instrument. Only used if `encryptedData` is passed. type: string billingAddress: nullable: true description: >- Merchant-provided billing address for the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. qrCode: type: string nullable: true description: >- QR Code provided on client-side and used to process a payment initiated by scanning a QR Code. eci: type: string description: >- The code indicating the result of the attempt to authenticate the cardholder. network: description: >- The card network of the encrypted instrument, e.g. Visa, Mastercard, American Express. type: string 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 preferredScheme: description: >- Selected card scheme to prefer when authorizing a co-badged card. type: string 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 displayName: type: string description: Instrument name suitable for display. default: type: boolean nullable: true description: >- Used to mark the new instrument as default. taxId: type: string description: >- Payer-provided tax identification number (e.g. CPF in Brazil) to store on the instrument. storeInstrument: type: boolean description: >- Flag indicating if the customer wants to store the Payment Instrument for using it in future executions. default: false enrollInstrumentToNetworkOffers: type: boolean description: >- Flag indicating if the customer wants to enroll a card to network offers program. If set to true, requires 'storeInstrument' to be true. default: false installments: type: object nullable: true description: > Indicates the payment needs to be made in installments. Should only be set if installments are supported in the region by the PSP and the payment method. During the validation of the request, if it is determined that installments is not supported, the request would fail with an error. additionalProperties: true properties: count: type: integer description: >- Number of installments in which the payment should be made. planReference: type: string description: >- Opaque plan handle, echoed from the selected plan. Send it whenever the plan carried one. totalAmount: type: number description: >- Total of the selected plan, echoed from the payment options response. requires: type: array description: >- Conditions the selected plan imposes, echoed from the payment options response. items: type: string enum: - threeDSecure - cardVerificationCode title: Authorize. - type: object properties: 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount to capture, including currency. Full amount will be captured if not specified. reason: type: string enum: - BetterPrice - CustomerDontNeed - DamagedProduct - Duplicate - FraudulentProduct - LateDelivery - NoReason - ProductMismatchDescription - WrongProduct - WrongProductSpecification description: >- Reason for invoking the operation or action. reasonDescription: type: string example: Customer's automatic subscription. description: >- An optional field to include any necessary information for the capture action. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. final: type: boolean description: >- The final parameter indicates if multiple partial captures are expected, if the value is false and the captured amount is less than the authorized amount then multiple partial captures can be applied until reaching the original authorized amount, if the value is true or the parameter is not sent the capture will be treated as a final capture and no further capture request will be accepted for it. title: Cancel. - type: object properties: paymentId: description: >- Optionally the ID of the payment to cancel. Used for payment links where an execution can have multiple successful payments. If not specified, the most recent payment done using the payment link will be cancelled. type: string format: uuid reason: type: string enum: - BetterPrice - CustomerDontNeed - DamagedProduct - Duplicate - FraudulentProduct - LateDelivery - NoReason - ProductMismatchDescription - WrongProduct - WrongProductSpecification description: >- Reason for invoking the operation or action. reasonDescription: type: string example: Customer's automatic subscription. description: >- An optional field to include any necessary information for the capture action. title: Capture. - type: object properties: 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount to refund, including currency. Full amount will be refunded if not specified. reason: type: string enum: - BetterPrice - CustomerDontNeed - DamagedProduct - Duplicate - FraudulentProduct - LateDelivery - NoReason - ProductMismatchDescription - WrongProduct - WrongProductSpecification description: >- Reason for invoking the operation or action. reasonDescription: type: string example: >- Customer was charged twice for the same order. description: >- An optional field to include any necessary information for the refund action. paymentId: description: >- Optionally the ID of the payment to refund. Used for payment links where an execution can have multiple successful payments. If not specified, the most recent payment done using the payment link will be refunded. type: string format: uuid 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. title: Refund. - type: object required: - data properties: data: type: object additionalProperties: true description: >- Any merchant-specific data that should be sent to confirm the payment. actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. title: Confirm. - type: object properties: 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. title: Lookup. - type: object required: - integrationType - amount properties: integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. paymentMethodCode: type: string enum: - applePay description: >- Code of the payment method selected to start a payment session. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. returnInfo: type: object description: > URLs from the merchant side where the consumer should be taken after a redirection flow. If no specific flow for `cancel` or `error` are needed, we will redirect to the value in the `success` URL. The 'pending' URL is used in case the consumer needs to be redirected back to a page if an execution stays in pending for some time. required: - success properties: success: type: string description: >- URL to redirect consumers to when the execution stops interacting with them due to progress. cancel: type: string description: >- URL to redirect consumers to when the execution is canceled. error: type: string description: >- URL to redirect consumers to when the execution encounters technical difficulties. pending: type: string description: >- URL to redirect consumers to when the execution stays in pending for some time. meta: description: >- Any merchant-specific data that should be used and carried for context in the action execution. anyOf: - title: General 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. - title: Apple Pay type: object required: - sessionURL properties: sessionURL: type: string description: >- Validation URL provided by Apple Pay client. title: Start payment session. response: type: object title: >- The response to the create execution request. Not present in case of error. anyOf: - allOf: - type: object required: - name - actionId - executedAt - links properties: name: type: string actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. workspaceId: type: string format: uuid description: >- Unique identifier of a workspace in Payrails. executedAt: type: string format: date-time description: >- Date and time when execution of the Action was started. links: type: object - type: object properties: name: type: string description: Triggers the selected payments on PSP. enum: - authorize links: type: object description: >- Links to the next possible actions that can be taken. required: - execution - consumerWait - cancel properties: execution: description: >- URL to fetch the current execution state. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE consumerWait: description: >- URL the consumer can be redirected to until payment is complete. This endpoint will redirect the consumer as needed for 3DS or other PSP interactions. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE capture: description: URL to capture the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE cancel: description: URL to cancel the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE refund: description: URL to refund the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE title: Authorize. - allOf: - type: object required: - name - actionId - executedAt - links properties: name: type: string actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. workspaceId: type: string format: uuid description: >- Unique identifier of a workspace in Payrails. executedAt: type: string format: date-time description: >- Date and time when execution of the Action was started. links: type: object - type: object properties: name: type: string description: Triggers the selected payments on PSP. enum: - capture reason: type: string enum: - BetterPrice - CustomerDontNeed - DamagedProduct - Duplicate - FraudulentProduct - LateDelivery - NoReason - ProductMismatchDescription - WrongProduct - WrongProductSpecification description: >- Reason for invoking the operation or action. reasonDescription: type: string description: >- An optional field to include any necessary information for the capture action. example: Monthly subscription. links: type: object description: >- Links to the next possible actions that can be taken. required: - execution - refund properties: execution: description: >- URL to fetch the current execution state. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE refund: description: URL to refund the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE title: Capture. - allOf: - type: object required: - name - actionId - executedAt - links properties: name: type: string actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. workspaceId: type: string format: uuid description: >- Unique identifier of a workspace in Payrails. executedAt: type: string format: date-time description: >- Date and time when execution of the Action was started. links: type: object - type: object properties: name: type: string description: Performed action name. enum: - cancel reason: type: string enum: - BetterPrice - CustomerDontNeed - DamagedProduct - Duplicate - FraudulentProduct - LateDelivery - NoReason - ProductMismatchDescription - WrongProduct - WrongProductSpecification description: >- Reason for invoking the operation or action. reasonDescription: type: string description: >- An optional field to include any necessary information for the cancel action. example: Customer's order expired. links: type: object description: >- Links to the next possible actions that can be taken. required: - execution properties: execution: description: >- URL to fetch the current execution state. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE title: Cancel. - allOf: - type: object required: - name - actionId - executedAt - links properties: name: type: string actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. workspaceId: type: string format: uuid description: >- Unique identifier of a workspace in Payrails. executedAt: type: string format: date-time description: >- Date and time when execution of the Action was started. links: type: object - type: object properties: name: type: string description: Performed action name. enum: - refund reason: type: string enum: - BetterPrice - CustomerDontNeed - DamagedProduct - Duplicate - FraudulentProduct - LateDelivery - NoReason - ProductMismatchDescription - WrongProduct - WrongProductSpecification description: >- Reason for invoking the operation or action. reasonDescription: type: string description: >- An optional field to include any necessary information for the refund action. example: Accidentally charged the customer twice. links: type: object description: >- Links to the next possible actions that can be taken. required: - execution properties: execution: description: >- URL to fetch the current execution state. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE title: Refund. - allOf: - type: object required: - name - actionId - executedAt - links properties: name: type: string actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. workspaceId: type: string format: uuid description: >- Unique identifier of a workspace in Payrails. executedAt: type: string format: date-time description: >- Date and time when execution of the Action was started. links: type: object - type: object properties: name: type: string description: Confirms the selected payments on PSP. enum: - confirm links: type: object description: >- Links to the next possible actions that can be taken. required: - execution - consumerWait - cancel properties: execution: description: >- URL to fetch the current execution state. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE consumerWait: description: >- URL the consumer can be redirected to until payment is complete. This endpoint will redirect the consumer as needed for 3DS or other PSP interactions. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE capture: description: URL to capture the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE cancel: description: URL to cancel the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE refund: description: URL to refund the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE title: Confirm. - allOf: - type: object required: - name - actionId - executedAt - links properties: name: type: string actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. workspaceId: type: string format: uuid description: >- Unique identifier of a workspace in Payrails. executedAt: type: string format: date-time description: >- Date and time when execution of the Action was started. links: type: object - type: object required: - data properties: name: type: string description: >- Lookup the available payment methods and instruments. enum: - lookup data: type: object description: Lookup action results. required: - paymentCompositionOptions properties: paymentCompositionOptions: type: array description: >- List of Payment Methods and Payment Instruments that can be used to complete the execution. items: type: object required: - integrationType - description properties: paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. providerCode: type: string description: >- Provider code for which the payment composition option is available. description: type: string description: Description of the Payment Method. providerData: type: object additionalProperties: true description: >- Provider-specific data needed by to use the payment method for a payment. paymentInstruments: type: array description: >- List of stored Payment Instruments for this Method that belong to the specified holder. By default, only includes the ones with status `Created` or `Enabled`. items: type: object allOf: - type: object required: - id - holderId - paymentMethod - status - createdAt - updatedAt properties: id: type: string format: uuid description: Id of the instrument. createdAt: type: string format: date-time description: >- Date and time when the Instrument was created in Payrails. updatedAt: type: string format: date-time description: When the Instrument was last updated. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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 - cashFreeWallet - paytmWallet - phonePe - iDeal - bancontact - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - scalapay status: type: string description: Status of the instrument. enum: - created - deleted - enabled - disabled - transient displayName: type: string description: Instrument name suitable for display. description: type: string description: Description of the instrument. default: type: boolean description: >- True if this instrument is set as default for the holder. nullable: true merchantReference: type: string description: >- Merchant-provided reference for the instrument. 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. 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 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. 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. data: description: >- Type-specific information about the instrument. anyOf: - title: Card type: object description: Data specific to a Card instrument. required: - {} - {} - {} properties: network: {} preferredScheme: {} bin: {} binLookup: {} billingAddress: {} suffix: {} expiryMonth: {} expiryYear: {} holderName: {} taxId: {} - title: BankAccount type: object description: >- Data specific to a BankAccount instrument. properties: holder: {} bank: {} account: {} - title: PayPal type: object description: Data specific to a PayPal instrument. properties: email: {} payerId: {} billingAddress: {} - title: GooglePay type: object description: Data specific to a GooglePay instrument. allOf: - {} - {} - title: ApplePay type: object description: Data specific to a ApplePay instrument. required: - {} - {} properties: network: {} networkDisplayName: {} binLookup: {} billingAddress: {} shippingAddress: {} suffix: {} expiryMonth: {} expiryYear: {} paymentToken: {} eci: {} cardHolderAuthenticated: {} - title: DCB type: object description: Data specific to a DCB instrument. properties: msisdn: {} msisdnTail: {} country: {} carrierNetwork: {} - title: MBWay type: object description: Data specific to an MB WAY instrument. properties: phone: {} - type: object properties: tokens: description: >- List of tokens inside the instrument. Not included by default, `includeTokens` query parameter must be used. type: array items: type: object required: - id - instrumentId - providerId - reference - status - type - createdAt - updatedAt properties: id: {} createdAt: {} updatedAt: {} instrumentId: {} status: {} type: {} providerId: {} providerConfigId: {} reference: {} meta: {} clientConfig: type: object description: >- Contains information related to the payment method and integration type. properties: displayName: type: string description: The payment method name. supportsSaveInstrument: type: boolean description: >- Returns true if the payment method supports storing a payment instrument. supportsBillingInfo: type: boolean description: >- Returns true if the merchant wants to collect billing information during checkout and if this information is supported by the payment methods. flow: type: string description: >- Enum with values direct and redirect, direct is set only when a payment method does not require redirecting the end user to a provider page to proceed with authorization. additionalConfig: type: object description: >- Specific configuration needed for the payment method. instrumentDataSchema: type: object description: Schema for the payment method. supportsInstallments: type: boolean description: >- Returns true if the payment method supports paying in installments. installments: type: object description: >- Installment plans keyed by ISO 3166-1 alpha-2 country. Empty when no plans are available for this card and amount. additionalProperties: type: array items: type: object description: >- Installment plan offered for the card and amount. Statically configured providers return only `count` and `amount`. required: - count - amount properties: count: type: integer description: >- Number of installments. Sent back as `installments.count` at authorize. example: 6 amount: type: number description: Amount paid per installment. example: 20 totalAmount: type: number description: >- Total paid across all installments, including financing cost. May exceed the transaction amount. example: 120 displayMessage: type: string description: >- Ready-to-render description of the plan. Always present for live plans. example: 6 cuotas de S/ 20.000,00 (S/ 120.000,00) installmentRate: type: number description: >- Financing rate as a percentage. `0` is a genuine interest-free offer; absent means no rate was supplied. example: 32.14 discountRate: type: number description: >- Discount as a percentage. Absent and `0` differ, as for `installmentRate`. recommended: type: boolean description: >- Marks the plan the provider suggests emphasising. totalAmountIsEstimate: type: boolean description: >- The card issuer applies the financing cost, so `totalAmount` is indicative. disclosures: type: array description: >- Financing rates a market requires be displayed, e.g. CFT and TEA. Values keep the provider's formatting. items: type: {} required: {} properties: {} requires: type: array description: >- Conditions the plan imposes beyond the normal card flow. Ignore unrecognised values and hide the plan. items: type: {} enum: {} planReference: type: string description: >- Opaque plan handle. Echo it back at authorize when present; never parse or display it. example: BR: - count: 2 amount: 60 - count: 6 amount: 20 links: type: object description: >- Links to the next possible actions that can be taken. required: - execution properties: execution: description: >- URL to fetch the current execution state. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE authorize: description: URL to authorize the current execution. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE startPaymentSession: description: URL to start a payment session. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE title: Lookup. - allOf: - type: object required: - name - actionId - executedAt - links properties: name: type: string actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. workspaceId: type: string format: uuid description: >- Unique identifier of a workspace in Payrails. executedAt: type: string format: date-time description: >- Date and time when execution of the Action was started. links: type: object - type: object required: - data properties: name: type: string description: >- Starts a payment session on a specific Provider. enum: - startPaymentSession data: type: object description: >- Provider-specific data needed to continue the payment session. additionalProperties: true links: type: object description: >- Links to the next possible actions that can be taken. required: - execution properties: execution: description: >- URL to fetch the current execution state. oneOf: - type: string - type: object description: Link related information. required: - href properties: href: type: string method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE title: Start payment session. - 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. title: Errors. - allOf: - type: object title: executionActionCompleted description: Execution action completed. required: - execution - action - success properties: action: type: string description: The type of completed action. enum: - authorize - payout - confirm - capture - cancel - refund - dispute actionId: type: string format: uuid description: >- The unique action execution identifier originally returned in the synchronous action response. execution: type: object description: >- The Workflow execution for which action was completed. required: - workflowCode - id - merchantReference - holderReference - meta properties: workflowCode: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. id: type: string format: uuid description: ID of Workflow execution. merchantReference: type: string description: >- Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system. holderReference: type: string description: >- Merchant-provided reference for the transaction counterparty, i.e. the paying consumer. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. success: type: boolean description: >- Action outcome. If `true`, then the action was finished successfully, and `false` otherwise. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The total amount used during execution of the action. reason: type: string enum: - BetterPrice - CustomerDontNeed - DamagedProduct - Duplicate - FraudulentProduct - LateDelivery - NoReason - ProductMismatchDescription - WrongProduct - WrongProductSpecification description: >- Reason for invoking the operation or action. reasonDescription: type: string description: >- Reason description specified when the action was initiated. example: Customer's order expired. errors: type: array description: >- The main reason why the action was not successful, set if `success = false`. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. - oneOf: - type: object properties: paymentComposition: type: array description: >- List of Payment Methods that were affected by the action. items: allOf: - type: object description: >- Base composition fields shared between payment and payout operations. required: - integrationType - amount - operationType - success properties: operationType: type: string description: >- Operation Type that was executed in the Provider. enum: - Authorize - Preauthorize - Capture - Cancel - Refund - Credit - SendNotification - CaptureNotification - RefundNotification - CancelNotification - AuthorizeNotification - ChargebackNotification - ChargebackReverseNotification - Get - Search - GetToken - Tokenize - DisableToken - Register - Generate3DS - Validate3DS - PayerAuthInit - PayerAuthCheckEnroll - PayerAuthValidate - RefundFailedNotification - RefundReversedNotification - CaptureFailedNotification - ValidateRedirect - RefundNotificationUpdated integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. paymentInstrumentId: type: string format: uuid description: >- Unique identifier of the Payment Instrument that the customer selected for the Payment. storeInstrument: type: boolean description: >- Holder intention to store the payment instrument on payout. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount used to execute the operation. success: type: boolean description: >- Operation outcome. If `true`, then the operation was finished successfully, and `false` otherwise. operationResult: type: string description: >- Result of the Operation according to Payrails mapping from the provider response. enum: - Success - Accepted - Pending - HTTPRedirectRequired - FormRedirectRequired - Unknown - UnexpectedProviderResponse - ProviderUnknownError - ProviderConnectionError - Timeout - ProviderTimeout - GenericRejection - FraudRisk - DuplicateOperation - OperationNotAllowed - InstrumentNotAllowed - InvalidInstrument - InsufficientBalance - BlockedInstrument - ExpiredInstrument - ValidationError - ParamsError - ProviderConfigError - InvalidSignature - InternalServerError - PayerCanceled - AuthenticationError - AuthenticationRequired - LimitExceeded - PaymentMethodNotSupported - AuthorizationRevoked providerId: type: string format: uuid description: >- Unique identifier of the provider used to execute the operation. provider: description: Provider used to execute the operation. type: object required: - id - name - displayName - type - createdAt - configSchema properties: id: type: string description: Unique identifier of the provider. format: uuid name: type: string description: Name of the provider. displayName: type: string description: Display name of the provider. type: type: string description: Provider type. enum: - Fraud - Payment - Payout - Vault - NetworkOffers - ThreeDS - NetworkGateway - NetworkToken - Bin - Data - Dispute - DisputeAlert - Tax - Billing status: type: string description: Status of the provider. enum: - active - inactive configSchema: type: string description: >- JSON schema of the provider configuration. selfOnboarding: type: object description: >- Self-onboarding capabilities available for this provider. properties: enabled: type: boolean description: >- Whether self-onboarding is enabled for this provider. supportedAuthModes: type: array description: >- Authentication modes supported for self-onboarding. items: type: string enum: - none - oauth notificationURLTemplate: type: string description: > Template of the notification URL for provider configs of that provider. The template contains variables between curly braces that can be mapped to the fields of the provider configs (e.g. `{id}`, `{accountName}`) and substituted to generate the notification URL of that provider config. createdAt: type: string format: date-time description: Date of creation of the provider. updatedAt: type: string format: date-time description: Last update of the provider. providerConfigId: type: string format: uuid description: >- Unique identifier of the provider configuration used to execute the operation. operationProviderReference: type: string description: >- Reference of the operation in the provider's system. errors: type: array description: >- The reason why the operation was not successful, set if `success = false`. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. accountFundingTransaction: type: boolean description: >- Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer. authorizationCode: type: string description: >- The acquirer authorization code if the payment was authorized. acquirerMID: type: string description: >- Merchant Identifier (MID) on the acquirer that processed the payment. acquirerAccountCode: type: string description: >- Account Code on the acquirer that processed the payment. acquirerCountryCode: type: string description: >- Country Code on the acquirer that processed the payment. avsResultCode: type: string description: > Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check. - `Y`: address and postal code both match. - `A`: address matches, postal code does not. - `Z`: postal code matches, address does not. - `N`: neither address nor postal code match. - `U`: the issuer could not perform the check. cvvResultCode: type: string description: > Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check. - `M`: security code matched. - `N`: security code did not match. - `U`: the issuer could not perform the check. - `P`: the check was expected but not processed. acquirerReference: type: string description: >- Acquirer Reference Number (ARN) assigned to the payment by the issuer. providerReference: type: string description: >- Unique identifier of the Payment in an external system, e.g. PSP. retrievalReference: type: string description: >- Retrieval Reference Number (RRN) assigned to the payment by the issuer. paymentInstrument: type: object description: >- Payment Instrument and tokens used to execute the authorize operation. allOf: - type: object required: - id - holderId - paymentMethod - status - createdAt - updatedAt properties: id: type: string format: uuid description: Id of the instrument. createdAt: type: string format: date-time description: >- Date and time when the Instrument was created in Payrails. updatedAt: type: string format: date-time description: When the Instrument was last updated. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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 - cashFreeWallet - paytmWallet - phonePe - iDeal - bancontact - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - scalapay status: type: string description: Status of the instrument. enum: - created - deleted - enabled - disabled - transient displayName: type: string description: Instrument name suitable for display. description: type: string description: Description of the instrument. default: type: boolean description: >- True if this instrument is set as default for the holder. nullable: true merchantReference: type: string description: >- Merchant-provided reference for the instrument. 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. 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 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. 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. data: description: >- Type-specific information about the instrument. anyOf: - title: Card type: object description: Data specific to a Card 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 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 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' binLookup: description: >- Information about an issuer by the given BIN (or IIN). type: object required: - bin properties: bin: type: {} minLength: {} maxLength: {} description: {} example: {} network: type: {} description: {} enum: {} localNetwork: description: {} type: {} enum: {} issuer: type: {} description: {} issuerCountry: description: {} type: {} required: {} properties: {} segment: type: {} description: {} type: type: {} description: {} typeDetails: type: {} description: {} isNetworkToken: type: {} description: {} isFlexCard: type: {} description: {} billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. holderName: type: string description: Name of the owner of the Card. taxId: type: string description: >- Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument. - title: BankAccount type: object description: >- Data specific to a BankAccount instrument. properties: holder: type: object description: >- The data structure for a holder's personal information. properties: firstName: type: {} description: {} lastName: type: {} description: {} companyName: type: {} description: {} address: description: {} type: {} properties: {} email: type: {} format: {} description: {} dob: type: {} format: {} description: {} country: description: {} type: {} required: {} properties: {} city: type: {} description: {} type: type: {} enum: {} description: {} bank: type: object description: >- The data structure for a bank's information. properties: name: type: {} description: {} branchCode: type: {} description: {} code: type: {} description: {} address: description: {} type: {} properties: {} swiftCode: type: {} description: {} account: type: object description: >- The data structure for an account's information. properties: number: type: {} description: {} iban: type: {} description: {} currency: type: {} pattern: {} example: {} description: {} country: description: {} type: {} required: {} properties: {} type: type: {} enum: {} description: {} - title: PayPal type: object description: Data specific to a PayPal instrument. properties: email: type: string description: Email of the PayPal account. payerId: type: string description: ID of the PayPal payer account. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} - title: GooglePay type: object description: Data specific to a GooglePay instrument. allOf: - type: object required: - network - suffix properties: network: type: {} description: {} enum: {} networkDisplayName: type: {} description: {} binLookup: description: {} type: {} properties: {} billingAddress: description: {} type: {} properties: {} shippingAddress: description: {} type: {} properties: {} suffix: type: {} minLength: {} maxLength: {} description: {} expiryMonth: type: {} minLength: {} maxLength: {} description: {} expiryYear: type: {} minLength: {} maxLength: {} description: {} paymentToken: type: {} description: {} eci: type: {} description: {} cardHolderAuthenticated: type: {} description: {} - type: object properties: googleMessageId: type: {} description: {} googleMessageExpirationId: type: {} description: {} - title: ApplePay type: object description: Data specific to a ApplePay 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 networkDisplayName: type: string description: Display-friendly name of the network. binLookup: description: Information about an issuer. type: object properties: network: type: {} description: {} enum: {} localNetwork: description: {} type: {} enum: {} issuer: type: {} description: {} issuerCountry: description: {} type: {} required: {} properties: {} segment: type: {} description: {} type: type: {} description: {} typeDetails: type: {} description: {} isNetworkToken: type: {} description: {} isFlexCard: type: {} description: {} billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} shippingAddress: description: Shipping Address provided by the wallet. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. paymentToken: type: string description: >- One-time payment token sent by client-side for execution of payment on backend. eci: type: string description: >- Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder. cardHolderAuthenticated: type: boolean description: >- Indicates that identification and verifications (ID&V) was performed on the returned payment credential. - title: DCB type: object description: Data specific to a DCB instrument. properties: msisdn: type: string description: >- Mobile number of the holder MSISDN Stands for Mobile Station International Subscriber Directory Number. msisdnTail: type: string description: >- Last 4 digits of the mobile number of the holder. country: description: Country of the holder. type: object required: - code properties: code: type: {} description: {} pattern: {} iso3: type: {} description: {} pattern: {} name: type: {} description: {} carrierNetwork: type: string description: Carrier network of the msisdn. - title: MBWay type: object description: Data specific to an MB WAY instrument. properties: phone: type: object description: >- Mobile number the payer confirms MB WAY payments with. properties: countryCode: type: {} description: {} example: {} number: type: {} description: {} example: {} - type: object properties: tokens: type: array description: >- Payment Instrument tokens used to execute the authorize operation. items: type: object properties: reference: type: string description: >- Unique identifier of the token in the provider's system. type: type: string description: Type of the token. enum: - network - vault - psp - networkOffers - networkGateway meta: description: >- Any provider-specific data that was stored for context in the token. type: object additionalProperties: true providerResponseAdditionalFields: type: object additionalProperties: true description: >- Any provider-specific response data requested by merchant on authorize. providerConfig: type: object description: >- Provider configuration details associated with this operation. properties: additionalData: type: object description: > Custom key-value data configured on the provider configuration. Do not store secrets, credentials, or personally identifiable information (PII). additionalProperties: type: string dispute: type: object description: >- Dispute related to the Workflow execution. required: - id - providerReference - amount - status - reason - network - createdAt properties: id: type: string format: uuid description: Unique identifier for a dispute entity. paymentId: type: string format: uuid description: >- Unique identifier for the payment related to the dispute. providerReference: type: string description: >- Unique identifier of the Dispute in an external system, e.g. PSP. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount used to execute the operation. status: type: string description: Status of a Dispute. enum: - FraudAlert - RetrievalOpened - RetrievalChallenged - RetrievalExpired - RetrievalClosed - DisputeNotified - DisputeOpened - DisputeChallenged - DisputeWon - DisputeLost - DisputeExpired - DisputeAccepted - DisputeCancelled - ArbitrationOpened - ArbitrationWon - ArbitrationLost activityType: type: string description: > What happened in the dispute event that triggered this notification, as a normalized label. Use it to detect a change - an escalation to the chargeback stage, evidence becoming due, a defense outcome - without keeping your own copy of the dispute's previous state to compare against. The values come from the same vocabulary as the dispute activity timeline. Note the two surfaces can label the same event differently: this field always uses the detailed vocabulary, while the timeline returned by the activities endpoint uses a coarser one unless detailed activity types are enabled for your account. Treat this field as the authoritative label for a notification. This labels a single event rather than describing a difference between two. An update that changes nothing is still delivered and repeats the previous label, so deduplicate on the dispute identifier together with this value if repeated notifications matter to you. The field is absent when the event cannot be classified. enum: - ChargebackNotification - ChargebackReverseNotification - PreArbitrationNotification - ArbitrationNotification - EvidenceRequired - EvidenceSubmitted - DisputeUnderReview - IssuerCommentsReceived - RetrievalNotification - FraudReportNotification - RetrievalInformationRequired - RetrievalEvidenceSubmitted - RetrievalUnderReview - RetrievalLost - RetrievalResolved - FraudReportReceived - ChargebackRaised - ChargebackEvidenceSubmittedPreDebit - ChargebackEvidenceReady - ChargebackNotDefendable - ChargebackAccepted - PreArbitrationOpened - PreArbitrationUnderReview - PreArbitrationWon - PreArbitrationLost - PreArbitrationSecondChargeback - PreArbitrationAccepted - ArbitrationOpened - ArbitrationEvidenceSubmitted - ArbitrationUnderReview - ArbitrationWon - ArbitrationLost - ArbitrationAccepted - AcceptDispute - DefendDispute - SubmitEvidence - DisputeWon - DisputeLost - DisputeResolved chargebackStatus: type: string enum: - Incoming - Executed - Reversed - SecondChargeback - IssuerReponseTimeframeExpired - ArbitrationReversed description: Status of the chargeback. previous: type: object description: >- The values this event replaced. Present with null members on the first event of a dispute, when there was nothing to replace. Omitted entirely for providers that keep no dispute of their own, where there is no previous state to report. properties: stage: oneOf: - type: string enum: - Created - FraudReport - Retrieval - Chargeback - PreArbitration - Arbitration - Unknown description: Stage of the dispute. - type: 'null' defenseStatus: oneOf: - type: string enum: - NotDefendable - Undefended - ReadyToSubmit - Submitted - Failed - UnderReview - Won - Lost - Accepted - Resolved - Unknown description: Status of the defense. - type: 'null' chargebackStatus: oneOf: - type: string enum: - Incoming - Executed - Reversed - SecondChargeback - IssuerReponseTimeframeExpired - ArbitrationReversed description: Status of the chargeback. - type: 'null' tags: type: array description: >- Names of the tags currently attached to the dispute. Omitted when the dispute has no tags. items: type: string reason: type: string description: >- Reason description indicating why the dispute was raised. reasonCode: type: string description: >- Reason code indicating why the dispute was raised. 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 createdAt: type: string format: date-time description: >- Exact date and time when the Dispute was created. retries: type: object description: >- Information about an action retry. Present if the action failed, and a retry is scheduled. properties: startedAt: type: string format: date-time description: >- Time when the retry is set up, but not performed yet. When it is scheduled to be perform can be checked in 'nextScheduledAt'. completedAttempts: type: integer description: >- Number of retry attempts completed so far. nextScheduledAt: type: string format: date-time description: >- Time when the next retry attempt will be performed. stopReason: type: string description: Reason for stopping further retries. idempotencyKey: type: string format: uuid description: >- Idempotency key used to retry in case of timeout. captureMode: description: >- Capture mode used for the payment operation. type: string enum: - Instant - Manual - Delayed - type: object properties: paymentId: description: >- Unique identifier of the Payment affected during execution of the operation. type: string format: uuid - type: object properties: payoutComposition: type: array description: >- List of Payout Methods that were affected by the action. items: allOf: - type: object description: >- Base composition fields shared between payment and payout operations. required: - integrationType - amount - operationType - success properties: operationType: type: string description: >- Operation Type that was executed in the Provider. enum: - Authorize - Preauthorize - Capture - Cancel - Refund - Credit - SendNotification - CaptureNotification - RefundNotification - CancelNotification - AuthorizeNotification - ChargebackNotification - ChargebackReverseNotification - Get - Search - GetToken - Tokenize - DisableToken - Register - Generate3DS - Validate3DS - PayerAuthInit - PayerAuthCheckEnroll - PayerAuthValidate - RefundFailedNotification - RefundReversedNotification - CaptureFailedNotification - ValidateRedirect - RefundNotificationUpdated integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. paymentInstrumentId: type: string format: uuid description: >- Unique identifier of the Payment Instrument that the customer selected for the Payment. storeInstrument: type: boolean description: >- Holder intention to store the payment instrument on payout. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount used to execute the operation. success: type: boolean description: >- Operation outcome. If `true`, then the operation was finished successfully, and `false` otherwise. operationResult: type: string description: >- Result of the Operation according to Payrails mapping from the provider response. enum: - Success - Accepted - Pending - HTTPRedirectRequired - FormRedirectRequired - Unknown - UnexpectedProviderResponse - ProviderUnknownError - ProviderConnectionError - Timeout - ProviderTimeout - GenericRejection - FraudRisk - DuplicateOperation - OperationNotAllowed - InstrumentNotAllowed - InvalidInstrument - InsufficientBalance - BlockedInstrument - ExpiredInstrument - ValidationError - ParamsError - ProviderConfigError - InvalidSignature - InternalServerError - PayerCanceled - AuthenticationError - AuthenticationRequired - LimitExceeded - PaymentMethodNotSupported - AuthorizationRevoked providerId: type: string format: uuid description: >- Unique identifier of the provider used to execute the operation. provider: description: Provider used to execute the operation. type: object required: - id - name - displayName - type - createdAt - configSchema properties: id: type: string description: Unique identifier of the provider. format: uuid name: type: string description: Name of the provider. displayName: type: string description: Display name of the provider. type: type: string description: Provider type. enum: - Fraud - Payment - Payout - Vault - NetworkOffers - ThreeDS - NetworkGateway - NetworkToken - Bin - Data - Dispute - DisputeAlert - Tax - Billing status: type: string description: Status of the provider. enum: - active - inactive configSchema: type: string description: >- JSON schema of the provider configuration. selfOnboarding: type: object description: >- Self-onboarding capabilities available for this provider. properties: enabled: type: boolean description: >- Whether self-onboarding is enabled for this provider. supportedAuthModes: type: array description: >- Authentication modes supported for self-onboarding. items: type: string enum: - none - oauth notificationURLTemplate: type: string description: > Template of the notification URL for provider configs of that provider. The template contains variables between curly braces that can be mapped to the fields of the provider configs (e.g. `{id}`, `{accountName}`) and substituted to generate the notification URL of that provider config. createdAt: type: string format: date-time description: Date of creation of the provider. updatedAt: type: string format: date-time description: Last update of the provider. providerConfigId: type: string format: uuid description: >- Unique identifier of the provider configuration used to execute the operation. operationProviderReference: type: string description: >- Reference of the operation in the provider's system. errors: type: array description: >- The reason why the operation was not successful, set if `success = false`. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. accountFundingTransaction: type: boolean description: >- Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer. authorizationCode: type: string description: >- The acquirer authorization code if the payment was authorized. acquirerMID: type: string description: >- Merchant Identifier (MID) on the acquirer that processed the payment. acquirerAccountCode: type: string description: >- Account Code on the acquirer that processed the payment. acquirerCountryCode: type: string description: >- Country Code on the acquirer that processed the payment. avsResultCode: type: string description: > Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check. - `Y`: address and postal code both match. - `A`: address matches, postal code does not. - `Z`: postal code matches, address does not. - `N`: neither address nor postal code match. - `U`: the issuer could not perform the check. cvvResultCode: type: string description: > Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check. - `M`: security code matched. - `N`: security code did not match. - `U`: the issuer could not perform the check. - `P`: the check was expected but not processed. acquirerReference: type: string description: >- Acquirer Reference Number (ARN) assigned to the payment by the issuer. providerReference: type: string description: >- Unique identifier of the Payment in an external system, e.g. PSP. retrievalReference: type: string description: >- Retrieval Reference Number (RRN) assigned to the payment by the issuer. paymentInstrument: type: object description: >- Payment Instrument and tokens used to execute the authorize operation. allOf: - type: object required: - id - holderId - paymentMethod - status - createdAt - updatedAt properties: id: type: string format: uuid description: Id of the instrument. createdAt: type: string format: date-time description: >- Date and time when the Instrument was created in Payrails. updatedAt: type: string format: date-time description: When the Instrument was last updated. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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 - cashFreeWallet - paytmWallet - phonePe - iDeal - bancontact - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - scalapay status: type: string description: Status of the instrument. enum: - created - deleted - enabled - disabled - transient displayName: type: string description: Instrument name suitable for display. description: type: string description: Description of the instrument. default: type: boolean description: >- True if this instrument is set as default for the holder. nullable: true merchantReference: type: string description: >- Merchant-provided reference for the instrument. 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. 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 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. 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. data: description: >- Type-specific information about the instrument. anyOf: - title: Card type: object description: Data specific to a Card 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 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 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' binLookup: description: >- Information about an issuer by the given BIN (or IIN). type: object required: - bin properties: bin: type: {} minLength: {} maxLength: {} description: {} example: {} network: type: {} description: {} enum: {} localNetwork: description: {} type: {} enum: {} issuer: type: {} description: {} issuerCountry: description: {} type: {} required: {} properties: {} segment: type: {} description: {} type: type: {} description: {} typeDetails: type: {} description: {} isNetworkToken: type: {} description: {} isFlexCard: type: {} description: {} billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. holderName: type: string description: Name of the owner of the Card. taxId: type: string description: >- Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument. - title: BankAccount type: object description: >- Data specific to a BankAccount instrument. properties: holder: type: object description: >- The data structure for a holder's personal information. properties: firstName: type: {} description: {} lastName: type: {} description: {} companyName: type: {} description: {} address: description: {} type: {} properties: {} email: type: {} format: {} description: {} dob: type: {} format: {} description: {} country: description: {} type: {} required: {} properties: {} city: type: {} description: {} type: type: {} enum: {} description: {} bank: type: object description: >- The data structure for a bank's information. properties: name: type: {} description: {} branchCode: type: {} description: {} code: type: {} description: {} address: description: {} type: {} properties: {} swiftCode: type: {} description: {} account: type: object description: >- The data structure for an account's information. properties: number: type: {} description: {} iban: type: {} description: {} currency: type: {} pattern: {} example: {} description: {} country: description: {} type: {} required: {} properties: {} type: type: {} enum: {} description: {} - title: PayPal type: object description: Data specific to a PayPal instrument. properties: email: type: string description: Email of the PayPal account. payerId: type: string description: ID of the PayPal payer account. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} - title: GooglePay type: object description: Data specific to a GooglePay instrument. allOf: - type: object required: - network - suffix properties: network: type: {} description: {} enum: {} networkDisplayName: type: {} description: {} binLookup: description: {} type: {} properties: {} billingAddress: description: {} type: {} properties: {} shippingAddress: description: {} type: {} properties: {} suffix: type: {} minLength: {} maxLength: {} description: {} expiryMonth: type: {} minLength: {} maxLength: {} description: {} expiryYear: type: {} minLength: {} maxLength: {} description: {} paymentToken: type: {} description: {} eci: type: {} description: {} cardHolderAuthenticated: type: {} description: {} - type: object properties: googleMessageId: type: {} description: {} googleMessageExpirationId: type: {} description: {} - title: ApplePay type: object description: Data specific to a ApplePay 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 networkDisplayName: type: string description: Display-friendly name of the network. binLookup: description: Information about an issuer. type: object properties: network: type: {} description: {} enum: {} localNetwork: description: {} type: {} enum: {} issuer: type: {} description: {} issuerCountry: description: {} type: {} required: {} properties: {} segment: type: {} description: {} type: type: {} description: {} typeDetails: type: {} description: {} isNetworkToken: type: {} description: {} isFlexCard: type: {} description: {} billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} shippingAddress: description: Shipping Address provided by the wallet. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. paymentToken: type: string description: >- One-time payment token sent by client-side for execution of payment on backend. eci: type: string description: >- Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder. cardHolderAuthenticated: type: boolean description: >- Indicates that identification and verifications (ID&V) was performed on the returned payment credential. - title: DCB type: object description: Data specific to a DCB instrument. properties: msisdn: type: string description: >- Mobile number of the holder MSISDN Stands for Mobile Station International Subscriber Directory Number. msisdnTail: type: string description: >- Last 4 digits of the mobile number of the holder. country: description: Country of the holder. type: object required: - code properties: code: type: {} description: {} pattern: {} iso3: type: {} description: {} pattern: {} name: type: {} description: {} carrierNetwork: type: string description: Carrier network of the msisdn. - title: MBWay type: object description: Data specific to an MB WAY instrument. properties: phone: type: object description: >- Mobile number the payer confirms MB WAY payments with. properties: countryCode: type: {} description: {} example: {} number: type: {} description: {} example: {} - type: object properties: tokens: type: array description: >- Payment Instrument tokens used to execute the authorize operation. items: type: object properties: reference: type: string description: >- Unique identifier of the token in the provider's system. type: type: string description: Type of the token. enum: - network - vault - psp - networkOffers - networkGateway meta: description: >- Any provider-specific data that was stored for context in the token. type: object additionalProperties: true providerResponseAdditionalFields: type: object additionalProperties: true description: >- Any provider-specific response data requested by merchant on authorize. providerConfig: type: object description: >- Provider configuration details associated with this operation. properties: additionalData: type: object description: > Custom key-value data configured on the provider configuration. Do not store secrets, credentials, or personally identifiable information (PII). additionalProperties: type: string dispute: type: object description: >- Dispute related to the Workflow execution. required: - id - providerReference - amount - status - reason - network - createdAt properties: id: type: string format: uuid description: Unique identifier for a dispute entity. paymentId: type: string format: uuid description: >- Unique identifier for the payment related to the dispute. providerReference: type: string description: >- Unique identifier of the Dispute in an external system, e.g. PSP. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount used to execute the operation. status: type: string description: Status of a Dispute. enum: - FraudAlert - RetrievalOpened - RetrievalChallenged - RetrievalExpired - RetrievalClosed - DisputeNotified - DisputeOpened - DisputeChallenged - DisputeWon - DisputeLost - DisputeExpired - DisputeAccepted - DisputeCancelled - ArbitrationOpened - ArbitrationWon - ArbitrationLost activityType: type: string description: > What happened in the dispute event that triggered this notification, as a normalized label. Use it to detect a change - an escalation to the chargeback stage, evidence becoming due, a defense outcome - without keeping your own copy of the dispute's previous state to compare against. The values come from the same vocabulary as the dispute activity timeline. Note the two surfaces can label the same event differently: this field always uses the detailed vocabulary, while the timeline returned by the activities endpoint uses a coarser one unless detailed activity types are enabled for your account. Treat this field as the authoritative label for a notification. This labels a single event rather than describing a difference between two. An update that changes nothing is still delivered and repeats the previous label, so deduplicate on the dispute identifier together with this value if repeated notifications matter to you. The field is absent when the event cannot be classified. enum: - ChargebackNotification - ChargebackReverseNotification - PreArbitrationNotification - ArbitrationNotification - EvidenceRequired - EvidenceSubmitted - DisputeUnderReview - IssuerCommentsReceived - RetrievalNotification - FraudReportNotification - RetrievalInformationRequired - RetrievalEvidenceSubmitted - RetrievalUnderReview - RetrievalLost - RetrievalResolved - FraudReportReceived - ChargebackRaised - ChargebackEvidenceSubmittedPreDebit - ChargebackEvidenceReady - ChargebackNotDefendable - ChargebackAccepted - PreArbitrationOpened - PreArbitrationUnderReview - PreArbitrationWon - PreArbitrationLost - PreArbitrationSecondChargeback - PreArbitrationAccepted - ArbitrationOpened - ArbitrationEvidenceSubmitted - ArbitrationUnderReview - ArbitrationWon - ArbitrationLost - ArbitrationAccepted - AcceptDispute - DefendDispute - SubmitEvidence - DisputeWon - DisputeLost - DisputeResolved chargebackStatus: type: string enum: - Incoming - Executed - Reversed - SecondChargeback - IssuerReponseTimeframeExpired - ArbitrationReversed description: Status of the chargeback. previous: type: object description: >- The values this event replaced. Present with null members on the first event of a dispute, when there was nothing to replace. Omitted entirely for providers that keep no dispute of their own, where there is no previous state to report. properties: stage: oneOf: - type: string enum: - Created - FraudReport - Retrieval - Chargeback - PreArbitration - Arbitration - Unknown description: Stage of the dispute. - type: 'null' defenseStatus: oneOf: - type: string enum: - NotDefendable - Undefended - ReadyToSubmit - Submitted - Failed - UnderReview - Won - Lost - Accepted - Resolved - Unknown description: Status of the defense. - type: 'null' chargebackStatus: oneOf: - type: string enum: - Incoming - Executed - Reversed - SecondChargeback - IssuerReponseTimeframeExpired - ArbitrationReversed description: Status of the chargeback. - type: 'null' tags: type: array description: >- Names of the tags currently attached to the dispute. Omitted when the dispute has no tags. items: type: string reason: type: string description: >- Reason description indicating why the dispute was raised. reasonCode: type: string description: >- Reason code indicating why the dispute was raised. 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 createdAt: type: string format: date-time description: >- Exact date and time when the Dispute was created. retries: type: object description: >- Information about an action retry. Present if the action failed, and a retry is scheduled. properties: startedAt: type: string format: date-time description: >- Time when the retry is set up, but not performed yet. When it is scheduled to be perform can be checked in 'nextScheduledAt'. completedAttempts: type: integer description: >- Number of retry attempts completed so far. nextScheduledAt: type: string format: date-time description: >- Time when the next retry attempt will be performed. stopReason: type: string description: Reason for stopping further retries. idempotencyKey: type: string format: uuid description: >- Idempotency key used to retry in case of timeout. captureMode: description: >- Capture mode used for the payment operation. type: string enum: - Instant - Manual - Delayed - type: object properties: payoutId: description: >- Unique identifier of the Payout affected during execution of the operation. type: string format: uuid - type: object title: ruleEngineExecuted description: Details for a ruleEngineExecuted event. required: - action - context properties: action: type: string enum: - determinePaymentOptions - determineProviderOptions - repeat description: Action name. rulesets: type: array description: The rulesets that were executed. items: type: object title: Ruleset. required: - id - version - workspaceId allOf: - type: object properties: createdAt: type: string format: date-time description: Creation date of the ruleset. - type: object required: - id - version properties: id: type: string format: uuid description: ID of Ruleset. version: type: number description: Ruleset version. - type: object required: - trigger - defaultAction properties: trigger: type: object description: >- An action that determines when the rules should be evaluated. required: - 'on' properties: 'on': type: string enum: - determinePaymentOptions - determineProviderOptions - repeat description: Action name. filter: description: >- A map of fields from the execution context and their expected values, which allows to trigger rules evaluation when all context field values match the expected ones. anyOf: - type: object title: Action `determinePaymentOptions` filter. description: >- Fields from execution context when payment options should be determined. properties: paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. - type: object title: >- Action `determineProviderOptions` filter. description: >- Fields from execution context when provider options should be determined. properties: workflowNode: type: string enum: - authorize - startPaymentSession description: Workflow node. providerConfigId: type: string format: uuid description: >- Unique identifier of the provider config. - type: object title: Action `repeat` filter. description: >- Fields from execution context when repeat should be determined. properties: workflowNode: type: string enum: - authorize description: Workflow node. rules: type: array description: >- Rules what need to be evaluated to execute or an action defined by a rule, which condition is fulfilled, or default action if none of conditions are fulfilled. items: type: object title: Rule. required: - condition - action properties: condition: type: object oneOf: - type: object title: Empty condition. description: >- A condition that checks whether a field is empty. required: - field - empty properties: field: type: string description: An execution context field name. empty: type: boolean description: >- Whether the field must be empty (`true`) or not empty (`false`). - type: object title: Simple condition. description: A simple condition. required: - field - operator oneOf: - required: - value - required: - referenceField properties: field: type: string description: An execution context field name. operator: type: string description: An operator. enum: - '=' - '>' - '>=' - < - <= - IN - IS ONE OF - CONTAINS - STARTS WITH - ENDS WITH value: description: >- An expected value of the execution context field. oneOf: - type: string description: String value. - type: number description: Number value. - type: boolean description: Boolean value. - type: array description: List of values. items: oneOf: - type: string - type: number referenceField: type: string description: >- Another execution context field name to compare with `field`. - type: object title: Combination of conditions. description: A combination of other condition types. required: - left - operator - right properties: left: type: object description: >- A condition, format of which is the same as `condition` field. operator: type: string description: >- A logical operator to combine 2 conditions. enum: - AND - OR right: type: object description: >- A condition, format of which is the same as `condition` field. - type: object title: Condition negation. description: >- A combination of a condition with NOT operator. required: - operator - right properties: operator: type: string description: >- A logical operator to negate a condition. enum: - NOT condition: type: object description: >- A condition, format of which is the same as `condition` field. description: >- Condition to be fulfilled to execute the action. action: type: object oneOf: - type: object title: Set capture mode. required: - type - params properties: type: type: string description: Set the capture mode. enum: - setCaptureMode params: type: object required: - mode properties: mode: type: string description: >- Capture mode to define if money is captured instantly, with delay or manually. enum: - Instant - Delayed - Manual - type: object title: Set cancel mode. required: - type - params properties: type: type: string description: Set the cancel mode. enum: - setCancelMode params: type: object required: - mode properties: mode: type: string description: >- Cancel mode to define if authorization is canceled manually or with delay. enum: - Delayed - Manual - type: object title: Set delay. required: - type - params properties: type: type: string description: >- Set delay for a target action (e.g. expiration, a capture in a 2 step authorization process, or a cancel). enum: - setDelay params: type: object properties: delay: type: string format: ISO 8601 description: Delay. - type: object title: Set priority. required: - type - params properties: type: type: string description: >- Set a priority for a target element (e.g. for a payment method in the payment options). enum: - setPriority params: type: object required: - priority properties: priority: type: number description: >- Priority number. Lower number is higher priority. - type: object title: Skip. required: - type properties: type: type: string description: >- Skip action. When returned, the targeted element will be skipped (e.g. skipping a payment method in the payment options). enum: - skip - type: object title: Stop. required: - type properties: type: type: string description: >- Stop action. When returned, the targeted action will be stopped (e.g. action retry attempt). enum: - stop - type: object title: Set instrument future usage. required: - type - params properties: type: type: string description: Set the future usage. enum: - setFutureUsage params: type: object required: - futureUsage properties: futureUsage: type: string description: >- Future usage to define the payment flows that the stored instrument will be used for. For cards, it is necessary to optimize the authorization rates and comply with regional legislation (such as SCA in EU) and card network rules. enum: - Subscription - CardOnFile - UnscheduledCardOnFile - type: object title: Add Next Step. required: - type - params properties: type: type: string enum: - addNextStep params: type: object title: Add Next Step Parameters. description: >- Parameters for adding a next step to the workflow queue. required: - code properties: code: type: string description: >- Code of the next workflow step to execute. mapping: type: array description: >- Mapping allows to add a field to the next workflow step input from the previous step output or set static values. items: type: object title: Field Mapping. description: >- Maps a field from source to destination or sets a static value. Using both 'from' and 'value' in the same mapping is not allowed. required: - to properties: from: type: string description: >- Source field path in the trigger request (optional if using static value). to: type: string description: >- Destination field path in the next step input. value: description: >- Static value to set in the destination field instead of mapping from source. - type: object title: Add Workflow Execution Status. required: - type - params properties: type: type: string enum: - addWorkflowExecutionStatus params: type: object title: Add Workflow Execution Status Parameters description: >- Parameters for adding a workflow execution status. required: - status properties: status: type: string description: Workflow execution status to add. description: >- Action to execute if the rule condition is fulfilled. defaultAction: type: object oneOf: - type: object title: Set capture mode. required: - type - params properties: type: type: string description: Set the capture mode. enum: - setCaptureMode params: type: object required: - mode properties: mode: type: string description: >- Capture mode to define if money is captured instantly, with delay or manually. enum: - Instant - Delayed - Manual - type: object title: Set cancel mode. required: - type - params properties: type: type: string description: Set the cancel mode. enum: - setCancelMode params: type: object required: - mode properties: mode: type: string description: >- Cancel mode to define if authorization is canceled manually or with delay. enum: - Delayed - Manual - type: object title: Set delay. required: - type - params properties: type: type: string description: >- Set delay for a target action (e.g. expiration, a capture in a 2 step authorization process, or a cancel). enum: - setDelay params: type: object properties: delay: type: string format: ISO 8601 description: Delay. - type: object title: Set priority. required: - type - params properties: type: type: string description: >- Set a priority for a target element (e.g. for a payment method in the payment options). enum: - setPriority params: type: object required: - priority properties: priority: type: number description: >- Priority number. Lower number is higher priority. - type: object title: Skip. required: - type properties: type: type: string description: >- Skip action. When returned, the targeted element will be skipped (e.g. skipping a payment method in the payment options). enum: - skip - type: object title: Stop. required: - type properties: type: type: string description: >- Stop action. When returned, the targeted action will be stopped (e.g. action retry attempt). enum: - stop - type: object title: Set instrument future usage. required: - type - params properties: type: type: string description: Set the future usage. enum: - setFutureUsage params: type: object required: - futureUsage properties: futureUsage: type: string description: >- Future usage to define the payment flows that the stored instrument will be used for. For cards, it is necessary to optimize the authorization rates and comply with regional legislation (such as SCA in EU) and card network rules. enum: - Subscription - CardOnFile - UnscheduledCardOnFile - type: object title: Add Next Step. required: - type - params properties: type: type: string enum: - addNextStep params: type: object title: Add Next Step Parameters. description: >- Parameters for adding a next step to the workflow queue. required: - code properties: code: type: string description: >- Code of the next workflow step to execute. mapping: type: array description: >- Mapping allows to add a field to the next workflow step input from the previous step output or set static values. items: type: object title: Field Mapping. description: >- Maps a field from source to destination or sets a static value. Using both 'from' and 'value' in the same mapping is not allowed. required: - to properties: from: type: string description: >- Source field path in the trigger request (optional if using static value). to: type: string description: >- Destination field path in the next step input. value: description: >- Static value to set in the destination field instead of mapping from source. - type: object title: Add Workflow Execution Status. required: - type - params properties: type: type: string enum: - addWorkflowExecutionStatus params: type: object title: Add Workflow Execution Status Parameters description: >- Parameters for adding a workflow execution status. required: - status properties: status: type: string description: Workflow execution status to add. description: >- Default action to execute if none of rule conditions are fulfilled. evaluations: type: array description: The evaluations of the rule engine. items: type: object required: - entity properties: chosenRule: type: object title: Rule. required: - condition - action properties: condition: type: object oneOf: - type: object title: Empty condition. description: >- A condition that checks whether a field is empty. required: - field - empty properties: field: type: string description: An execution context field name. empty: type: boolean description: >- Whether the field must be empty (`true`) or not empty (`false`). - type: object title: Simple condition. description: A simple condition. required: - field - operator oneOf: - required: - value - required: - referenceField properties: field: type: string description: An execution context field name. operator: type: string description: An operator. enum: - '=' - '>' - '>=' - < - <= - IN - IS ONE OF - CONTAINS - STARTS WITH - ENDS WITH value: description: >- An expected value of the execution context field. oneOf: - type: string description: String value. - type: number description: Number value. - type: boolean description: Boolean value. - type: array description: List of values. items: oneOf: - type: string - type: number referenceField: type: string description: >- Another execution context field name to compare with `field`. - type: object title: Combination of conditions. description: A combination of other condition types. required: - left - operator - right properties: left: type: object description: >- A condition, format of which is the same as `condition` field. operator: type: string description: >- A logical operator to combine 2 conditions. enum: - AND - OR right: type: object description: >- A condition, format of which is the same as `condition` field. - type: object title: Condition negation. description: >- A combination of a condition with NOT operator. required: - operator - right properties: operator: type: string description: >- A logical operator to negate a condition. enum: - NOT condition: type: object description: >- A condition, format of which is the same as `condition` field. description: >- Condition to be fulfilled to execute the action. action: type: object oneOf: - type: object title: Set capture mode. required: - type - params properties: type: type: string description: Set the capture mode. enum: - setCaptureMode params: type: object required: - mode properties: mode: type: string description: >- Capture mode to define if money is captured instantly, with delay or manually. enum: - Instant - Delayed - Manual - type: object title: Set cancel mode. required: - type - params properties: type: type: string description: Set the cancel mode. enum: - setCancelMode params: type: object required: - mode properties: mode: type: string description: >- Cancel mode to define if authorization is canceled manually or with delay. enum: - Delayed - Manual - type: object title: Set delay. required: - type - params properties: type: type: string description: >- Set delay for a target action (e.g. expiration, a capture in a 2 step authorization process, or a cancel). enum: - setDelay params: type: object properties: delay: type: string format: ISO 8601 description: Delay. - type: object title: Set priority. required: - type - params properties: type: type: string description: >- Set a priority for a target element (e.g. for a payment method in the payment options). enum: - setPriority params: type: object required: - priority properties: priority: type: number description: >- Priority number. Lower number is higher priority. - type: object title: Skip. required: - type properties: type: type: string description: >- Skip action. When returned, the targeted element will be skipped (e.g. skipping a payment method in the payment options). enum: - skip - type: object title: Stop. required: - type properties: type: type: string description: >- Stop action. When returned, the targeted action will be stopped (e.g. action retry attempt). enum: - stop - type: object title: Set instrument future usage. required: - type - params properties: type: type: string description: Set the future usage. enum: - setFutureUsage params: type: object required: - futureUsage properties: futureUsage: type: string description: >- Future usage to define the payment flows that the stored instrument will be used for. For cards, it is necessary to optimize the authorization rates and comply with regional legislation (such as SCA in EU) and card network rules. enum: - Subscription - CardOnFile - UnscheduledCardOnFile - type: object title: Add Next Step. required: - type - params properties: type: type: string enum: - addNextStep params: type: object title: Add Next Step Parameters. description: >- Parameters for adding a next step to the workflow queue. required: - code properties: code: type: string description: >- Code of the next workflow step to execute. mapping: type: array description: >- Mapping allows to add a field to the next workflow step input from the previous step output or set static values. items: type: object title: Field Mapping. description: >- Maps a field from source to destination or sets a static value. Using both 'from' and 'value' in the same mapping is not allowed. required: - to properties: from: type: string description: >- Source field path in the trigger request (optional if using static value). to: type: string description: >- Destination field path in the next step input. value: description: >- Static value to set in the destination field instead of mapping from source. - type: object title: Add Workflow Execution Status. required: - type - params properties: type: type: string enum: - addWorkflowExecutionStatus params: type: object title: Add Workflow Execution Status Parameters description: >- Parameters for adding a workflow execution status. required: - status properties: status: type: string description: Workflow execution status to add. description: >- Action to execute if the rule condition is fulfilled. action: type: object oneOf: - type: object title: Set capture mode. required: - type - params properties: type: type: string description: Set the capture mode. enum: - setCaptureMode params: type: object required: - mode properties: mode: type: string description: >- Capture mode to define if money is captured instantly, with delay or manually. enum: - Instant - Delayed - Manual - type: object title: Set cancel mode. required: - type - params properties: type: type: string description: Set the cancel mode. enum: - setCancelMode params: type: object required: - mode properties: mode: type: string description: >- Cancel mode to define if authorization is canceled manually or with delay. enum: - Delayed - Manual - type: object title: Set delay. required: - type - params properties: type: type: string description: >- Set delay for a target action (e.g. expiration, a capture in a 2 step authorization process, or a cancel). enum: - setDelay params: type: object properties: delay: type: string format: ISO 8601 description: Delay. - type: object title: Set priority. required: - type - params properties: type: type: string description: >- Set a priority for a target element (e.g. for a payment method in the payment options). enum: - setPriority params: type: object required: - priority properties: priority: type: number description: >- Priority number. Lower number is higher priority. - type: object title: Skip. required: - type properties: type: type: string description: >- Skip action. When returned, the targeted element will be skipped (e.g. skipping a payment method in the payment options). enum: - skip - type: object title: Stop. required: - type properties: type: type: string description: >- Stop action. When returned, the targeted action will be stopped (e.g. action retry attempt). enum: - stop - type: object title: Set instrument future usage. required: - type - params properties: type: type: string description: Set the future usage. enum: - setFutureUsage params: type: object required: - futureUsage properties: futureUsage: type: string description: >- Future usage to define the payment flows that the stored instrument will be used for. For cards, it is necessary to optimize the authorization rates and comply with regional legislation (such as SCA in EU) and card network rules. enum: - Subscription - CardOnFile - UnscheduledCardOnFile - type: object title: Add Next Step. required: - type - params properties: type: type: string enum: - addNextStep params: type: object title: Add Next Step Parameters. description: >- Parameters for adding a next step to the workflow queue. required: - code properties: code: type: string description: >- Code of the next workflow step to execute. mapping: type: array description: >- Mapping allows to add a field to the next workflow step input from the previous step output or set static values. items: type: object title: Field Mapping. description: >- Maps a field from source to destination or sets a static value. Using both 'from' and 'value' in the same mapping is not allowed. required: - to properties: from: type: string description: >- Source field path in the trigger request (optional if using static value). to: type: string description: >- Destination field path in the next step input. value: description: >- Static value to set in the destination field instead of mapping from source. - type: object title: Add Workflow Execution Status. required: - type - params properties: type: type: string enum: - addWorkflowExecutionStatus params: type: object title: Add Workflow Execution Status Parameters description: >- Parameters for adding a workflow execution status. required: - status properties: status: type: string description: Workflow execution status to add. entity: anyOf: - type: object required: - integrationType - description properties: paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. providerCode: type: string description: >- Provider code for which the payment composition option is available. description: type: string description: Description of the Payment Method. providerData: type: object additionalProperties: true description: >- Provider-specific data needed by to use the payment method for a payment. paymentInstruments: type: array description: >- List of stored Payment Instruments for this Method that belong to the specified holder. By default, only includes the ones with status `Created` or `Enabled`. items: type: object allOf: - type: object required: - id - holderId - paymentMethod - status - createdAt - updatedAt properties: id: type: string format: uuid description: Id of the instrument. createdAt: type: string format: date-time description: >- Date and time when the Instrument was created in Payrails. updatedAt: type: string format: date-time description: When the Instrument was last updated. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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 - cashFreeWallet - paytmWallet - phonePe - iDeal - bancontact - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - scalapay status: type: string description: Status of the instrument. enum: - created - deleted - enabled - disabled - transient displayName: type: string description: Instrument name suitable for display. description: type: string description: Description of the instrument. default: type: boolean description: >- True if this instrument is set as default for the holder. nullable: true merchantReference: type: string description: >- Merchant-provided reference for the instrument. 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. 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 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. 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. data: description: >- Type-specific information about the instrument. anyOf: - title: Card type: object description: Data specific to a Card 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 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 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' 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' network: type: string description: Network of the instrument. enum: - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} localNetwork: description: >- Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact. type: string enum: - {} - {} - {} - {} issuer: type: string description: >- Name of the bank or institution that issued the card. issuerCountry: description: >- Country of the bank or institution that issued the card. type: object required: - {} properties: code: {} iso3: {} name: {} segment: type: string description: >- Segment of the card, e.g. gold, black, business. type: type: string description: >- Type of the card, e.g. credit, debit, prepaid, gift. typeDetails: type: string description: >- More information about the card type, e.g. personal, commercial. isNetworkToken: type: boolean description: > Indicates whether the card credential represents a network token rather than a primary account number (PAN). 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. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. country: description: The country where the address is in. type: object required: - {} properties: code: {} iso3: {} name: {} latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - {} properties: countryCode: {} number: {} alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. holderName: type: string description: Name of the owner of the Card. taxId: type: string description: >- Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument. - title: BankAccount type: object description: >- Data specific to a BankAccount 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. lastName: type: string description: The last name of the account holder. companyName: type: string description: The company name for business holders. address: description: The address of the account holder. type: object properties: street: {} doorNumber: {} complement: {} area: {} city: {} postalCode: {} state: {} country: {} latitude: {} longitude: {} phone: {} alias: {} name: {} lastName: {} email: {} email: type: string format: email description: The email address of the account holder. dob: type: string format: date description: >- The date of birth of the account holder (YYYY-MM-DD). country: description: The country of the account holder. type: object required: - {} properties: code: {} iso3: {} name: {} city: type: string description: The city of the account holder. type: type: string enum: - {} - {} description: The type of account holder. bank: type: object description: >- The data structure for a bank's information. properties: name: type: string description: The name of the bank. branchCode: type: string description: The branch code of the bank. code: type: string description: The bank code. address: description: The address of the bank. type: object properties: street: {} doorNumber: {} complement: {} area: {} city: {} postalCode: {} state: {} country: {} latitude: {} longitude: {} phone: {} alias: {} name: {} lastName: {} email: {} swiftCode: type: string description: The SWIFT/BIC code of the bank. account: type: object description: >- The data structure for an account's information. properties: number: type: string description: The bank account number. iban: type: string description: >- The International Bank Account Number (IBAN). currency: type: string pattern: ^[A-Z]{3}$ example: USD description: ISO 3-letter currency code. country: description: The country of the account. type: object required: - {} properties: code: {} iso3: {} name: {} type: type: string enum: - {} - {} description: The type of bank account. - title: PayPal type: object description: Data specific to a PayPal instrument. properties: email: type: string description: Email of the PayPal account. payerId: type: string description: ID of the PayPal payer account. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. country: description: The country where the address is in. type: object required: - {} properties: code: {} iso3: {} name: {} latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - {} properties: countryCode: {} number: {} alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. - title: GooglePay type: object description: Data specific to a GooglePay instrument. allOf: - type: object required: - network - suffix properties: network: type: string description: Network of the instrument. enum: - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} networkDisplayName: type: string description: Display-friendly name of the network. binLookup: description: Information about an issuer. type: object properties: network: {} localNetwork: {} issuer: {} issuerCountry: {} segment: {} type: {} typeDetails: {} isNetworkToken: {} isFlexCard: {} billingAddress: description: Billing Address of the instrument. type: object properties: street: {} doorNumber: {} complement: {} area: {} city: {} postalCode: {} state: {} country: {} latitude: {} longitude: {} phone: {} alias: {} name: {} lastName: {} email: {} shippingAddress: description: Shipping Address provided by the wallet. type: object properties: street: {} doorNumber: {} complement: {} area: {} city: {} postalCode: {} state: {} country: {} latitude: {} longitude: {} phone: {} alias: {} name: {} lastName: {} email: {} suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. paymentToken: type: string description: >- One-time payment token sent by client-side for execution of payment on backend. eci: type: string description: >- Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder. cardHolderAuthenticated: type: boolean description: >- Indicates that identification and verifications (ID&V) was performed on the returned payment credential. - type: object properties: googleMessageId: type: string description: >- Unique identifier for the Google Pay message. googleMessageExpirationId: type: string description: >- Expiration time for the Google Pay message. - title: ApplePay type: object description: Data specific to a ApplePay 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 networkDisplayName: type: string description: Display-friendly name of the network. binLookup: description: Information about an issuer. type: object properties: network: type: string description: Network of the instrument. enum: - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} localNetwork: description: >- Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact. type: string enum: - {} - {} - {} - {} issuer: type: string description: >- Name of the bank or institution that issued the card. issuerCountry: description: >- Country of the bank or institution that issued the card. type: object required: - {} properties: code: {} iso3: {} name: {} segment: type: string description: >- Segment of the card, e.g. gold, black, business. type: type: string description: >- Type of the card, e.g. credit, debit, prepaid, gift. typeDetails: type: string description: >- More information about the card type, e.g. personal, commercial. isNetworkToken: type: boolean description: > Indicates whether the card credential represents a network token rather than a primary account number (PAN). 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. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. country: description: The country where the address is in. type: object required: - {} properties: code: {} iso3: {} name: {} latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - {} properties: countryCode: {} number: {} alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. shippingAddress: description: Shipping Address provided by the wallet. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. country: description: The country where the address is in. type: object required: - {} properties: code: {} iso3: {} name: {} latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - {} properties: countryCode: {} number: {} alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. paymentToken: type: string description: >- One-time payment token sent by client-side for execution of payment on backend. eci: type: string description: >- Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder. cardHolderAuthenticated: type: boolean description: >- Indicates that identification and verifications (ID&V) was performed on the returned payment credential. - title: DCB type: object description: Data specific to a DCB instrument. properties: msisdn: type: string description: >- Mobile number of the holder MSISDN Stands for Mobile Station International Subscriber Directory Number. msisdnTail: type: string description: >- Last 4 digits of the mobile number of the holder. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. carrierNetwork: type: string description: Carrier network of the msisdn. - title: MBWay type: object description: Data specific to an MB WAY 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' number: type: string description: National number, digits only. example: '912345678' - type: object properties: tokens: description: >- List of tokens inside the instrument. Not included by default, `includeTokens` query parameter must be used. type: array items: type: object required: - id - instrumentId - providerId - reference - status - type - createdAt - updatedAt properties: id: type: string format: uuid description: Id of the token in Payrails. createdAt: type: string format: date-time description: >- Date and time when the Token was created in Payrails. updatedAt: type: string format: date-time description: When the Token was last updated. instrumentId: type: string format: uuid description: >- Id of the payment instrument the token belongs to. status: type: string description: Status of the token. enum: - created - enabled - disabled - deleted type: type: string description: Type of the token. enum: - network - vault - psp - networkOffers - networkGateway providerId: type: string format: uuid description: Id of the provider the token belongs to. providerConfigId: type: string format: uuid description: >- Id of the configuration in the provider the token belongs to. reference: type: string description: >- Unique identifier of the token in the provider's system. meta: description: >- Any merchant or provider-specific data that should be stored for context in the token. type: object additionalProperties: true clientConfig: type: object description: >- Contains information related to the payment method and integration type. properties: displayName: type: string description: The payment method name. supportsSaveInstrument: type: boolean description: >- Returns true if the payment method supports storing a payment instrument. supportsBillingInfo: type: boolean description: >- Returns true if the merchant wants to collect billing information during checkout and if this information is supported by the payment methods. flow: type: string description: >- Enum with values direct and redirect, direct is set only when a payment method does not require redirecting the end user to a provider page to proceed with authorization. additionalConfig: type: object description: >- Specific configuration needed for the payment method. instrumentDataSchema: type: object description: Schema for the payment method. supportsInstallments: type: boolean description: >- Returns true if the payment method supports paying in installments. installments: type: object description: >- Installment plans keyed by ISO 3166-1 alpha-2 country. Empty when no plans are available for this card and amount. additionalProperties: type: array items: type: object description: >- Installment plan offered for the card and amount. Statically configured providers return only `count` and `amount`. required: - count - amount properties: count: type: integer description: >- Number of installments. Sent back as `installments.count` at authorize. example: 6 amount: type: number description: Amount paid per installment. example: 20 totalAmount: type: number description: >- Total paid across all installments, including financing cost. May exceed the transaction amount. example: 120 displayMessage: type: string description: >- Ready-to-render description of the plan. Always present for live plans. example: 6 cuotas de S/ 20.000,00 (S/ 120.000,00) installmentRate: type: number description: >- Financing rate as a percentage. `0` is a genuine interest-free offer; absent means no rate was supplied. example: 32.14 discountRate: type: number description: >- Discount as a percentage. Absent and `0` differ, as for `installmentRate`. recommended: type: boolean description: >- Marks the plan the provider suggests emphasising. totalAmountIsEstimate: type: boolean description: >- The card issuer applies the financing cost, so `totalAmount` is indicative. disclosures: type: array description: >- Financing rates a market requires be displayed, e.g. CFT and TEA. Values keep the provider's formatting. items: type: object required: - code - value properties: code: type: string description: Name of the rate. example: CFT value: type: string description: Rate as the provider expressed it. example: 169,00% requires: type: array description: >- Conditions the plan imposes beyond the normal card flow. Ignore unrecognised values and hide the plan. items: type: string enum: - threeDSecure - cardVerificationCode planReference: type: string description: >- Opaque plan handle. Echo it back at authorize when present; never parse or display it. example: BR: - count: 2 amount: 60 - count: 6 amount: 20 title: Payment composition option. - title: Provider option. type: object required: - id - providerId - createdAt - accountName - configSchema - accountDisplayName properties: id: type: string format: uuid description: >- Unique identifier of the provider config. providerId: type: string description: Unique identifier of the provider. format: uuid accountName: type: string description: Account name of the provider. format: string pattern: ^[a-zA-Z0-9_-]*$ configSchema: type: string description: >- JSON schema of the provider configuration. createdAt: type: string format: date-time description: Date of creation of the provider config. status: type: string description: The status of the provider config. config: type: object accountDisplayName: type: string description: Account display name of the provider. format: string workspaces: type: array description: >- Workspaces that the Provider config belongs to. items: type: string format: uuid providerName: type: string description: Name of the provider. providerDisplayName: type: string description: Display name of the provider. notificationUrl: type: string description: >- Notification URL for this provider config. additionalData: type: object description: > Custom key-value data included in authorization webhook notifications. Do not store secrets, credentials, or personally identifiable information (PII). additionalProperties: type: string - type: number title: Delay in nanosecond. ruleEvaluationResults: type: array items: type: object properties: rule: type: object title: Rule. required: - condition - action properties: condition: type: object oneOf: - type: object title: Empty condition. description: >- A condition that checks whether a field is empty. required: - field - empty properties: field: type: string description: An execution context field name. empty: type: boolean description: >- Whether the field must be empty (`true`) or not empty (`false`). - type: object title: Simple condition. description: A simple condition. required: - field - operator oneOf: - required: - value - required: - referenceField properties: field: type: string description: An execution context field name. operator: type: string description: An operator. enum: - '=' - '>' - '>=' - < - <= - IN - IS ONE OF - CONTAINS - STARTS WITH - ENDS WITH value: description: >- An expected value of the execution context field. oneOf: - type: string description: String value. - type: number description: Number value. - type: boolean description: Boolean value. - type: array description: List of values. items: oneOf: - type: string - type: number referenceField: type: string description: >- Another execution context field name to compare with `field`. - type: object title: Combination of conditions. description: A combination of other condition types. required: - left - operator - right properties: left: type: object description: >- A condition, format of which is the same as `condition` field. operator: type: string description: >- A logical operator to combine 2 conditions. enum: - AND - OR right: type: object description: >- A condition, format of which is the same as `condition` field. - type: object title: Condition negation. description: >- A combination of a condition with NOT operator. required: - operator - right properties: operator: type: string description: >- A logical operator to negate a condition. enum: - NOT condition: type: object description: >- A condition, format of which is the same as `condition` field. description: >- Condition to be fulfilled to execute the action. action: type: object oneOf: - type: object title: Set capture mode. required: - type - params properties: type: type: string description: Set the capture mode. enum: - setCaptureMode params: type: object required: - mode properties: mode: type: string description: >- Capture mode to define if money is captured instantly, with delay or manually. enum: - Instant - Delayed - Manual - type: object title: Set cancel mode. required: - type - params properties: type: type: string description: Set the cancel mode. enum: - setCancelMode params: type: object required: - mode properties: mode: type: string description: >- Cancel mode to define if authorization is canceled manually or with delay. enum: - Delayed - Manual - type: object title: Set delay. required: - type - params properties: type: type: string description: >- Set delay for a target action (e.g. expiration, a capture in a 2 step authorization process, or a cancel). enum: - setDelay params: type: object properties: delay: type: string format: ISO 8601 description: Delay. - type: object title: Set priority. required: - type - params properties: type: type: string description: >- Set a priority for a target element (e.g. for a payment method in the payment options). enum: - setPriority params: type: object required: - priority properties: priority: type: number description: >- Priority number. Lower number is higher priority. - type: object title: Skip. required: - type properties: type: type: string description: >- Skip action. When returned, the targeted element will be skipped (e.g. skipping a payment method in the payment options). enum: - skip - type: object title: Stop. required: - type properties: type: type: string description: >- Stop action. When returned, the targeted action will be stopped (e.g. action retry attempt). enum: - stop - type: object title: Set instrument future usage. required: - type - params properties: type: type: string description: Set the future usage. enum: - setFutureUsage params: type: object required: - futureUsage properties: futureUsage: type: string description: >- Future usage to define the payment flows that the stored instrument will be used for. For cards, it is necessary to optimize the authorization rates and comply with regional legislation (such as SCA in EU) and card network rules. enum: - Subscription - CardOnFile - UnscheduledCardOnFile - type: object title: Add Next Step. required: - type - params properties: type: type: string enum: - addNextStep params: type: object title: Add Next Step Parameters. description: >- Parameters for adding a next step to the workflow queue. required: - code properties: code: type: string description: >- Code of the next workflow step to execute. mapping: type: array description: >- Mapping allows to add a field to the next workflow step input from the previous step output or set static values. items: type: object title: Field Mapping. description: >- Maps a field from source to destination or sets a static value. Using both 'from' and 'value' in the same mapping is not allowed. required: - to properties: from: type: string description: >- Source field path in the trigger request (optional if using static value). to: type: string description: >- Destination field path in the next step input. value: description: >- Static value to set in the destination field instead of mapping from source. - type: object title: Add Workflow Execution Status. required: - type - params properties: type: type: string enum: - addWorkflowExecutionStatus params: type: object title: Add Workflow Execution Status Parameters description: >- Parameters for adding a workflow execution status. required: - status properties: status: type: string description: Workflow execution status to add. description: >- Action to execute if the rule condition is fulfilled. result: type: boolean description: >- Whether or not the rule was successfully executed. error: 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. context: type: object title: >- The execution context used to execute the rule engine. properties: 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. dynamic: type: object description: Additional computed metadata. additionalProperties: true errors: type: array title: >- Errors that occurred during the execution of the rule engine. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. - type: object title: networkOffersEnrollmentCompleted description: Network offers enrollment completed. required: - execution - success properties: actionId: type: string format: uuid description: >- The unique action execution identifier originally returned in the synchronous action response. execution: type: object description: >- The Workflow execution for which action was completed. required: - workflowCode - id - merchantReference - holderReference - meta properties: workflowCode: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. id: type: string format: uuid description: ID of Workflow execution. merchantReference: type: string description: >- Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system. holderReference: type: string description: >- Merchant-provided reference for the transaction counterparty, i.e. the paying consumer. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. success: type: boolean description: >- Outcome. If `true`, then the action was finished successfully, and `false` otherwise. paymentComposition: type: array description: >- List of Payment Methods that were affected by the action. items: type: object required: - integrationType - paymentMethodCode - success properties: integrationType: type: string enum: - api description: >- Integration type used to execute the enrollment. paymentMethodCode: type: string enum: - card description: >- Code of the payment method used to execute the enrollment in the provider. paymentInstrumentId: type: string format: uuid description: >- Unique identifier of the Payment Instrument that the customer selected for the Payment. storeInstrument: type: boolean description: >- Holder intention to store the payment instrument on authorize. success: type: boolean description: >- Operation outcome. If `true`, then the enrollment was finished successfully, and `false` otherwise. operationResult: type: string description: >- Result of the Operation according to Payrails mapping from the provider response. enum: - Success - Accepted - Pending - HTTPRedirectRequired - FormRedirectRequired - Unknown - UnexpectedProviderResponse - ProviderUnknownError - ProviderConnectionError - Timeout - ProviderTimeout - GenericRejection - FraudRisk - DuplicateOperation - OperationNotAllowed - InstrumentNotAllowed - InvalidInstrument - InsufficientBalance - BlockedInstrument - ExpiredInstrument - ValidationError - ParamsError - ProviderConfigError - InvalidSignature - InternalServerError - PayerCanceled - AuthenticationError - AuthenticationRequired - LimitExceeded - PaymentMethodNotSupported - AuthorizationRevoked providerId: type: string format: uuid description: >- Unique identifier of the provider used to execute the enrollment. providerConfigId: type: string format: uuid description: >- Unique identifier of the provider configuration used to execute the enrollment. operationProviderReference: type: string description: >- Reference of the operation in the provider's system. errors: type: array description: >- The reason why the operation was not successful, set if `success = false`. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. paymentInstrument: type: object description: >- Payment Instrument and tokens what was enrolled to network offers. allOf: - type: object required: - id - holderId - paymentMethod - status - createdAt - updatedAt properties: id: type: string format: uuid description: Id of the instrument. createdAt: type: string format: date-time description: >- Date and time when the Instrument was created in Payrails. updatedAt: type: string format: date-time description: When the Instrument was last updated. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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 - cashFreeWallet - paytmWallet - phonePe - iDeal - bancontact - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - scalapay status: type: string description: Status of the instrument. enum: - created - deleted - enabled - disabled - transient displayName: type: string description: Instrument name suitable for display. description: type: string description: Description of the instrument. default: type: boolean description: >- True if this instrument is set as default for the holder. nullable: true merchantReference: type: string description: >- Merchant-provided reference for the instrument. 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. 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 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. 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. data: description: >- Type-specific information about the instrument. anyOf: - title: Card type: object description: Data specific to a Card 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 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 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' 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' 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 localNetwork: description: >- Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact. type: string enum: - bancontact - cartesbancaires - dankort - mada issuer: type: string description: >- Name of the bank or institution that issued the card. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. segment: type: string description: >- Segment of the card, e.g. gold, black, business. type: type: string description: >- Type of the card, e.g. credit, debit, prepaid, gift. typeDetails: type: string description: >- More information about the card type, e.g. personal, commercial. isNetworkToken: type: boolean description: > Indicates whether the card credential represents a network token rather than a primary account number (PAN). 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. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. holderName: type: string description: Name of the owner of the Card. taxId: type: string description: >- Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument. - title: BankAccount type: object description: >- Data specific to a BankAccount 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. lastName: type: string description: The last name of the account holder. companyName: type: string description: The company name for business holders. address: description: The address of the account holder. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. email: type: string format: email description: The email address of the account holder. dob: type: string format: date description: >- The date of birth of the account holder (YYYY-MM-DD). 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. city: type: string description: The city of the account holder. type: type: string enum: - individual - corporate description: The type of account holder. bank: type: object description: >- The data structure for a bank's information. properties: name: type: string description: The name of the bank. branchCode: type: string description: The branch code of the bank. code: type: string description: The bank code. address: description: The address of the bank. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. swiftCode: type: string description: The SWIFT/BIC code of the bank. account: type: object description: >- The data structure for an account's information. properties: number: type: string description: The bank account number. iban: type: string description: >- The International Bank Account Number (IBAN). currency: type: string pattern: ^[A-Z]{3}$ example: USD description: ISO 3-letter currency code. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. type: type: string enum: - savings - current description: The type of bank account. - title: PayPal type: object description: Data specific to a PayPal instrument. properties: email: type: string description: Email of the PayPal account. payerId: type: string description: ID of the PayPal payer account. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. - title: GooglePay type: object description: Data specific to a GooglePay instrument. allOf: - type: object 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 networkDisplayName: type: string description: Display-friendly name of the network. 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 localNetwork: description: >- Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact. type: string enum: - bancontact - cartesbancaires - dankort - mada issuer: type: string description: >- Name of the bank or institution that issued the card. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. segment: type: string description: >- Segment of the card, e.g. gold, black, business. type: type: string description: >- Type of the card, e.g. credit, debit, prepaid, gift. typeDetails: type: string description: >- More information about the card type, e.g. personal, commercial. isNetworkToken: type: boolean description: > Indicates whether the card credential represents a network token rather than a primary account number (PAN). 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. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. shippingAddress: description: Shipping Address provided by the wallet. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. paymentToken: type: string description: >- One-time payment token sent by client-side for execution of payment on backend. eci: type: string description: >- Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder. cardHolderAuthenticated: type: boolean description: >- Indicates that identification and verifications (ID&V) was performed on the returned payment credential. - type: object properties: googleMessageId: type: string description: >- Unique identifier for the Google Pay message. googleMessageExpirationId: type: string description: >- Expiration time for the Google Pay message. - title: ApplePay type: object description: Data specific to a ApplePay 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 networkDisplayName: type: string description: Display-friendly name of the network. 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 localNetwork: description: >- Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact. type: string enum: - bancontact - cartesbancaires - dankort - mada issuer: type: string description: >- Name of the bank or institution that issued the card. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. segment: type: string description: >- Segment of the card, e.g. gold, black, business. type: type: string description: >- Type of the card, e.g. credit, debit, prepaid, gift. typeDetails: type: string description: >- More information about the card type, e.g. personal, commercial. isNetworkToken: type: boolean description: > Indicates whether the card credential represents a network token rather than a primary account number (PAN). 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. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. shippingAddress: description: Shipping Address provided by the wallet. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. paymentToken: type: string description: >- One-time payment token sent by client-side for execution of payment on backend. eci: type: string description: >- Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder. cardHolderAuthenticated: type: boolean description: >- Indicates that identification and verifications (ID&V) was performed on the returned payment credential. - title: DCB type: object description: Data specific to a DCB instrument. properties: msisdn: type: string description: >- Mobile number of the holder MSISDN Stands for Mobile Station International Subscriber Directory Number. msisdnTail: type: string description: >- Last 4 digits of the mobile number of the holder. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. carrierNetwork: type: string description: Carrier network of the msisdn. - title: MBWay type: object description: Data specific to an MB WAY 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' number: type: string description: National number, digits only. example: '912345678' - type: object properties: tokens: type: array description: >- Payment Instrument tokens created as a result of the enrollment. items: type: object properties: reference: type: string description: >- Unique identifier of the token in the provider's system. type: type: string description: Type of the token. enum: - network - vault - psp - networkOffers - networkGateway meta: description: >- Any provider-specific data that was stored for context in the token. type: object additionalProperties: true errors: type: array description: >- The main reason why the action was not successful, set if `success = false`. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. - title: executionActionScheduled type: object description: Details for an executionActionScheduled event. required: - action - reason - scheduledAt properties: action: type: string enum: - authorizeRetry description: Type of action. actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. reason: type: string description: Reason for scheduling of the action. scheduledAt: type: string format: date-time description: Time for the execution of the action. - title: executionActionUnscheduled type: object description: Details for an executionActionUnscheduled event. required: - action - reason properties: action: type: string enum: - authorizeRetry description: Type of action. actionId: type: string format: uuid description: >- Unique identifier for this action execution. If its processing is done asynchronously, you will receive a notification with the same `actionId`. reason: type: string description: Reason for unscheduling of the action. - allOf: - type: object title: executionActionUpdated description: Execution action updated. required: - execution - action - success properties: action: type: string description: The type of updated action. enum: - authorize - capture - cancel - refund - dispute actionId: type: string format: uuid description: >- The unique action execution identifier originally returned in the synchronous action response. execution: type: object description: >- The Workflow execution for which action was updated. required: - workflowCode - id - merchantReference - holderReference - meta properties: workflowCode: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. id: type: string format: uuid description: ID of Workflow execution. merchantReference: type: string description: >- Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system. holderReference: type: string description: >- Merchant-provided reference for the transaction counterparty, i.e. the paying consumer. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. success: type: boolean description: >- Action outcome. If `true`, then the action was finished successfully, and `false` otherwise. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The total amount used during execution of the action. errors: type: array description: >- The main reason why the action was not successful, set if `success = false`. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. - oneOf: - type: object properties: paymentComposition: type: array description: >- List of Payment Methods that were affected by the action. items: allOf: - type: object description: >- Base composition fields shared between payment and payout operations. required: - integrationType - amount - operationType - success properties: operationType: type: string description: >- Operation Type that was executed in the Provider. enum: - Authorize - Preauthorize - Capture - Cancel - Refund - Credit - SendNotification - CaptureNotification - RefundNotification - CancelNotification - AuthorizeNotification - ChargebackNotification - ChargebackReverseNotification - Get - Search - GetToken - Tokenize - DisableToken - Register - Generate3DS - Validate3DS - PayerAuthInit - PayerAuthCheckEnroll - PayerAuthValidate - RefundFailedNotification - RefundReversedNotification - CaptureFailedNotification - ValidateRedirect - RefundNotificationUpdated integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. paymentInstrumentId: type: string format: uuid description: >- Unique identifier of the Payment Instrument that the customer selected for the Payment. storeInstrument: type: boolean description: >- Holder intention to store the payment instrument on payout. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount used to execute the operation. success: type: boolean description: >- Operation outcome. If `true`, then the operation was finished successfully, and `false` otherwise. operationResult: type: string description: >- Result of the Operation according to Payrails mapping from the provider response. enum: - Success - Accepted - Pending - HTTPRedirectRequired - FormRedirectRequired - Unknown - UnexpectedProviderResponse - ProviderUnknownError - ProviderConnectionError - Timeout - ProviderTimeout - GenericRejection - FraudRisk - DuplicateOperation - OperationNotAllowed - InstrumentNotAllowed - InvalidInstrument - InsufficientBalance - BlockedInstrument - ExpiredInstrument - ValidationError - ParamsError - ProviderConfigError - InvalidSignature - InternalServerError - PayerCanceled - AuthenticationError - AuthenticationRequired - LimitExceeded - PaymentMethodNotSupported - AuthorizationRevoked providerId: type: string format: uuid description: >- Unique identifier of the provider used to execute the operation. provider: description: Provider used to execute the operation. type: object required: - id - name - displayName - type - createdAt - configSchema properties: id: type: string description: Unique identifier of the provider. format: uuid name: type: string description: Name of the provider. displayName: type: string description: Display name of the provider. type: type: string description: Provider type. enum: - Fraud - Payment - Payout - Vault - NetworkOffers - ThreeDS - NetworkGateway - NetworkToken - Bin - Data - Dispute - DisputeAlert - Tax - Billing status: type: string description: Status of the provider. enum: - active - inactive configSchema: type: string description: >- JSON schema of the provider configuration. selfOnboarding: type: object description: >- Self-onboarding capabilities available for this provider. properties: enabled: type: boolean description: >- Whether self-onboarding is enabled for this provider. supportedAuthModes: type: array description: >- Authentication modes supported for self-onboarding. items: type: string enum: - none - oauth notificationURLTemplate: type: string description: > Template of the notification URL for provider configs of that provider. The template contains variables between curly braces that can be mapped to the fields of the provider configs (e.g. `{id}`, `{accountName}`) and substituted to generate the notification URL of that provider config. createdAt: type: string format: date-time description: Date of creation of the provider. updatedAt: type: string format: date-time description: Last update of the provider. providerConfigId: type: string format: uuid description: >- Unique identifier of the provider configuration used to execute the operation. operationProviderReference: type: string description: >- Reference of the operation in the provider's system. errors: type: array description: >- The reason why the operation was not successful, set if `success = false`. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. accountFundingTransaction: type: boolean description: >- Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer. authorizationCode: type: string description: >- The acquirer authorization code if the payment was authorized. acquirerMID: type: string description: >- Merchant Identifier (MID) on the acquirer that processed the payment. acquirerAccountCode: type: string description: >- Account Code on the acquirer that processed the payment. acquirerCountryCode: type: string description: >- Country Code on the acquirer that processed the payment. avsResultCode: type: string description: > Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check. - `Y`: address and postal code both match. - `A`: address matches, postal code does not. - `Z`: postal code matches, address does not. - `N`: neither address nor postal code match. - `U`: the issuer could not perform the check. cvvResultCode: type: string description: > Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check. - `M`: security code matched. - `N`: security code did not match. - `U`: the issuer could not perform the check. - `P`: the check was expected but not processed. acquirerReference: type: string description: >- Acquirer Reference Number (ARN) assigned to the payment by the issuer. providerReference: type: string description: >- Unique identifier of the Payment in an external system, e.g. PSP. retrievalReference: type: string description: >- Retrieval Reference Number (RRN) assigned to the payment by the issuer. paymentInstrument: type: object description: >- Payment Instrument and tokens used to execute the authorize operation. allOf: - type: object required: - id - holderId - paymentMethod - status - createdAt - updatedAt properties: id: type: string format: uuid description: Id of the instrument. createdAt: type: string format: date-time description: >- Date and time when the Instrument was created in Payrails. updatedAt: type: string format: date-time description: When the Instrument was last updated. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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 - cashFreeWallet - paytmWallet - phonePe - iDeal - bancontact - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - scalapay status: type: string description: Status of the instrument. enum: - created - deleted - enabled - disabled - transient displayName: type: string description: Instrument name suitable for display. description: type: string description: Description of the instrument. default: type: boolean description: >- True if this instrument is set as default for the holder. nullable: true merchantReference: type: string description: >- Merchant-provided reference for the instrument. 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. 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 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. 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. data: description: >- Type-specific information about the instrument. anyOf: - title: Card type: object description: Data specific to a Card 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 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 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' binLookup: description: >- Information about an issuer by the given BIN (or IIN). type: object required: - bin properties: bin: type: {} minLength: {} maxLength: {} description: {} example: {} network: type: {} description: {} enum: {} localNetwork: description: {} type: {} enum: {} issuer: type: {} description: {} issuerCountry: description: {} type: {} required: {} properties: {} segment: type: {} description: {} type: type: {} description: {} typeDetails: type: {} description: {} isNetworkToken: type: {} description: {} isFlexCard: type: {} description: {} billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. holderName: type: string description: Name of the owner of the Card. taxId: type: string description: >- Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument. - title: BankAccount type: object description: >- Data specific to a BankAccount instrument. properties: holder: type: object description: >- The data structure for a holder's personal information. properties: firstName: type: {} description: {} lastName: type: {} description: {} companyName: type: {} description: {} address: description: {} type: {} properties: {} email: type: {} format: {} description: {} dob: type: {} format: {} description: {} country: description: {} type: {} required: {} properties: {} city: type: {} description: {} type: type: {} enum: {} description: {} bank: type: object description: >- The data structure for a bank's information. properties: name: type: {} description: {} branchCode: type: {} description: {} code: type: {} description: {} address: description: {} type: {} properties: {} swiftCode: type: {} description: {} account: type: object description: >- The data structure for an account's information. properties: number: type: {} description: {} iban: type: {} description: {} currency: type: {} pattern: {} example: {} description: {} country: description: {} type: {} required: {} properties: {} type: type: {} enum: {} description: {} - title: PayPal type: object description: Data specific to a PayPal instrument. properties: email: type: string description: Email of the PayPal account. payerId: type: string description: ID of the PayPal payer account. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} - title: GooglePay type: object description: Data specific to a GooglePay instrument. allOf: - type: object required: - network - suffix properties: network: type: {} description: {} enum: {} networkDisplayName: type: {} description: {} binLookup: description: {} type: {} properties: {} billingAddress: description: {} type: {} properties: {} shippingAddress: description: {} type: {} properties: {} suffix: type: {} minLength: {} maxLength: {} description: {} expiryMonth: type: {} minLength: {} maxLength: {} description: {} expiryYear: type: {} minLength: {} maxLength: {} description: {} paymentToken: type: {} description: {} eci: type: {} description: {} cardHolderAuthenticated: type: {} description: {} - type: object properties: googleMessageId: type: {} description: {} googleMessageExpirationId: type: {} description: {} - title: ApplePay type: object description: Data specific to a ApplePay 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 networkDisplayName: type: string description: Display-friendly name of the network. binLookup: description: Information about an issuer. type: object properties: network: type: {} description: {} enum: {} localNetwork: description: {} type: {} enum: {} issuer: type: {} description: {} issuerCountry: description: {} type: {} required: {} properties: {} segment: type: {} description: {} type: type: {} description: {} typeDetails: type: {} description: {} isNetworkToken: type: {} description: {} isFlexCard: type: {} description: {} billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} shippingAddress: description: Shipping Address provided by the wallet. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. paymentToken: type: string description: >- One-time payment token sent by client-side for execution of payment on backend. eci: type: string description: >- Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder. cardHolderAuthenticated: type: boolean description: >- Indicates that identification and verifications (ID&V) was performed on the returned payment credential. - title: DCB type: object description: Data specific to a DCB instrument. properties: msisdn: type: string description: >- Mobile number of the holder MSISDN Stands for Mobile Station International Subscriber Directory Number. msisdnTail: type: string description: >- Last 4 digits of the mobile number of the holder. country: description: Country of the holder. type: object required: - code properties: code: type: {} description: {} pattern: {} iso3: type: {} description: {} pattern: {} name: type: {} description: {} carrierNetwork: type: string description: Carrier network of the msisdn. - title: MBWay type: object description: Data specific to an MB WAY instrument. properties: phone: type: object description: >- Mobile number the payer confirms MB WAY payments with. properties: countryCode: type: {} description: {} example: {} number: type: {} description: {} example: {} - type: object properties: tokens: type: array description: >- Payment Instrument tokens used to execute the authorize operation. items: type: object properties: reference: type: string description: >- Unique identifier of the token in the provider's system. type: type: string description: Type of the token. enum: - network - vault - psp - networkOffers - networkGateway meta: description: >- Any provider-specific data that was stored for context in the token. type: object additionalProperties: true providerResponseAdditionalFields: type: object additionalProperties: true description: >- Any provider-specific response data requested by merchant on authorize. providerConfig: type: object description: >- Provider configuration details associated with this operation. properties: additionalData: type: object description: > Custom key-value data configured on the provider configuration. Do not store secrets, credentials, or personally identifiable information (PII). additionalProperties: type: string dispute: type: object description: >- Dispute related to the Workflow execution. required: - id - providerReference - amount - status - reason - network - createdAt properties: id: type: string format: uuid description: Unique identifier for a dispute entity. paymentId: type: string format: uuid description: >- Unique identifier for the payment related to the dispute. providerReference: type: string description: >- Unique identifier of the Dispute in an external system, e.g. PSP. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount used to execute the operation. status: type: string description: Status of a Dispute. enum: - FraudAlert - RetrievalOpened - RetrievalChallenged - RetrievalExpired - RetrievalClosed - DisputeNotified - DisputeOpened - DisputeChallenged - DisputeWon - DisputeLost - DisputeExpired - DisputeAccepted - DisputeCancelled - ArbitrationOpened - ArbitrationWon - ArbitrationLost activityType: type: string description: > What happened in the dispute event that triggered this notification, as a normalized label. Use it to detect a change - an escalation to the chargeback stage, evidence becoming due, a defense outcome - without keeping your own copy of the dispute's previous state to compare against. The values come from the same vocabulary as the dispute activity timeline. Note the two surfaces can label the same event differently: this field always uses the detailed vocabulary, while the timeline returned by the activities endpoint uses a coarser one unless detailed activity types are enabled for your account. Treat this field as the authoritative label for a notification. This labels a single event rather than describing a difference between two. An update that changes nothing is still delivered and repeats the previous label, so deduplicate on the dispute identifier together with this value if repeated notifications matter to you. The field is absent when the event cannot be classified. enum: - ChargebackNotification - ChargebackReverseNotification - PreArbitrationNotification - ArbitrationNotification - EvidenceRequired - EvidenceSubmitted - DisputeUnderReview - IssuerCommentsReceived - RetrievalNotification - FraudReportNotification - RetrievalInformationRequired - RetrievalEvidenceSubmitted - RetrievalUnderReview - RetrievalLost - RetrievalResolved - FraudReportReceived - ChargebackRaised - ChargebackEvidenceSubmittedPreDebit - ChargebackEvidenceReady - ChargebackNotDefendable - ChargebackAccepted - PreArbitrationOpened - PreArbitrationUnderReview - PreArbitrationWon - PreArbitrationLost - PreArbitrationSecondChargeback - PreArbitrationAccepted - ArbitrationOpened - ArbitrationEvidenceSubmitted - ArbitrationUnderReview - ArbitrationWon - ArbitrationLost - ArbitrationAccepted - AcceptDispute - DefendDispute - SubmitEvidence - DisputeWon - DisputeLost - DisputeResolved chargebackStatus: type: string enum: - Incoming - Executed - Reversed - SecondChargeback - IssuerReponseTimeframeExpired - ArbitrationReversed description: Status of the chargeback. previous: type: object description: >- The values this event replaced. Present with null members on the first event of a dispute, when there was nothing to replace. Omitted entirely for providers that keep no dispute of their own, where there is no previous state to report. properties: stage: oneOf: - type: string enum: - Created - FraudReport - Retrieval - Chargeback - PreArbitration - Arbitration - Unknown description: Stage of the dispute. - type: 'null' defenseStatus: oneOf: - type: string enum: - NotDefendable - Undefended - ReadyToSubmit - Submitted - Failed - UnderReview - Won - Lost - Accepted - Resolved - Unknown description: Status of the defense. - type: 'null' chargebackStatus: oneOf: - type: string enum: - Incoming - Executed - Reversed - SecondChargeback - IssuerReponseTimeframeExpired - ArbitrationReversed description: Status of the chargeback. - type: 'null' tags: type: array description: >- Names of the tags currently attached to the dispute. Omitted when the dispute has no tags. items: type: string reason: type: string description: >- Reason description indicating why the dispute was raised. reasonCode: type: string description: >- Reason code indicating why the dispute was raised. 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 createdAt: type: string format: date-time description: >- Exact date and time when the Dispute was created. retries: type: object description: >- Information about an action retry. Present if the action failed, and a retry is scheduled. properties: startedAt: type: string format: date-time description: >- Time when the retry is set up, but not performed yet. When it is scheduled to be perform can be checked in 'nextScheduledAt'. completedAttempts: type: integer description: >- Number of retry attempts completed so far. nextScheduledAt: type: string format: date-time description: >- Time when the next retry attempt will be performed. stopReason: type: string description: Reason for stopping further retries. idempotencyKey: type: string format: uuid description: >- Idempotency key used to retry in case of timeout. captureMode: description: >- Capture mode used for the payment operation. type: string enum: - Instant - Manual - Delayed - type: object properties: paymentId: description: >- Unique identifier of the Payment affected during execution of the operation. type: string format: uuid - type: object properties: payoutComposition: type: array description: >- List of Payout Methods that were affected by the action. items: allOf: - type: object description: >- Base composition fields shared between payment and payout operations. required: - integrationType - amount - operationType - success properties: operationType: type: string description: >- Operation Type that was executed in the Provider. enum: - Authorize - Preauthorize - Capture - Cancel - Refund - Credit - SendNotification - CaptureNotification - RefundNotification - CancelNotification - AuthorizeNotification - ChargebackNotification - ChargebackReverseNotification - Get - Search - GetToken - Tokenize - DisableToken - Register - Generate3DS - Validate3DS - PayerAuthInit - PayerAuthCheckEnroll - PayerAuthValidate - RefundFailedNotification - RefundReversedNotification - CaptureFailedNotification - ValidateRedirect - RefundNotificationUpdated integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. paymentInstrumentId: type: string format: uuid description: >- Unique identifier of the Payment Instrument that the customer selected for the Payment. storeInstrument: type: boolean description: >- Holder intention to store the payment instrument on payout. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount used to execute the operation. success: type: boolean description: >- Operation outcome. If `true`, then the operation was finished successfully, and `false` otherwise. operationResult: type: string description: >- Result of the Operation according to Payrails mapping from the provider response. enum: - Success - Accepted - Pending - HTTPRedirectRequired - FormRedirectRequired - Unknown - UnexpectedProviderResponse - ProviderUnknownError - ProviderConnectionError - Timeout - ProviderTimeout - GenericRejection - FraudRisk - DuplicateOperation - OperationNotAllowed - InstrumentNotAllowed - InvalidInstrument - InsufficientBalance - BlockedInstrument - ExpiredInstrument - ValidationError - ParamsError - ProviderConfigError - InvalidSignature - InternalServerError - PayerCanceled - AuthenticationError - AuthenticationRequired - LimitExceeded - PaymentMethodNotSupported - AuthorizationRevoked providerId: type: string format: uuid description: >- Unique identifier of the provider used to execute the operation. provider: description: Provider used to execute the operation. type: object required: - id - name - displayName - type - createdAt - configSchema properties: id: type: string description: Unique identifier of the provider. format: uuid name: type: string description: Name of the provider. displayName: type: string description: Display name of the provider. type: type: string description: Provider type. enum: - Fraud - Payment - Payout - Vault - NetworkOffers - ThreeDS - NetworkGateway - NetworkToken - Bin - Data - Dispute - DisputeAlert - Tax - Billing status: type: string description: Status of the provider. enum: - active - inactive configSchema: type: string description: >- JSON schema of the provider configuration. selfOnboarding: type: object description: >- Self-onboarding capabilities available for this provider. properties: enabled: type: boolean description: >- Whether self-onboarding is enabled for this provider. supportedAuthModes: type: array description: >- Authentication modes supported for self-onboarding. items: type: string enum: - none - oauth notificationURLTemplate: type: string description: > Template of the notification URL for provider configs of that provider. The template contains variables between curly braces that can be mapped to the fields of the provider configs (e.g. `{id}`, `{accountName}`) and substituted to generate the notification URL of that provider config. createdAt: type: string format: date-time description: Date of creation of the provider. updatedAt: type: string format: date-time description: Last update of the provider. providerConfigId: type: string format: uuid description: >- Unique identifier of the provider configuration used to execute the operation. operationProviderReference: type: string description: >- Reference of the operation in the provider's system. errors: type: array description: >- The reason why the operation was not successful, set if `success = false`. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. accountFundingTransaction: type: boolean description: >- Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer. authorizationCode: type: string description: >- The acquirer authorization code if the payment was authorized. acquirerMID: type: string description: >- Merchant Identifier (MID) on the acquirer that processed the payment. acquirerAccountCode: type: string description: >- Account Code on the acquirer that processed the payment. acquirerCountryCode: type: string description: >- Country Code on the acquirer that processed the payment. avsResultCode: type: string description: > Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check. - `Y`: address and postal code both match. - `A`: address matches, postal code does not. - `Z`: postal code matches, address does not. - `N`: neither address nor postal code match. - `U`: the issuer could not perform the check. cvvResultCode: type: string description: > Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check. - `M`: security code matched. - `N`: security code did not match. - `U`: the issuer could not perform the check. - `P`: the check was expected but not processed. acquirerReference: type: string description: >- Acquirer Reference Number (ARN) assigned to the payment by the issuer. providerReference: type: string description: >- Unique identifier of the Payment in an external system, e.g. PSP. retrievalReference: type: string description: >- Retrieval Reference Number (RRN) assigned to the payment by the issuer. paymentInstrument: type: object description: >- Payment Instrument and tokens used to execute the authorize operation. allOf: - type: object required: - id - holderId - paymentMethod - status - createdAt - updatedAt properties: id: type: string format: uuid description: Id of the instrument. createdAt: type: string format: date-time description: >- Date and time when the Instrument was created in Payrails. updatedAt: type: string format: date-time description: When the Instrument was last updated. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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 - cashFreeWallet - paytmWallet - phonePe - iDeal - bancontact - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - scalapay status: type: string description: Status of the instrument. enum: - created - deleted - enabled - disabled - transient displayName: type: string description: Instrument name suitable for display. description: type: string description: Description of the instrument. default: type: boolean description: >- True if this instrument is set as default for the holder. nullable: true merchantReference: type: string description: >- Merchant-provided reference for the instrument. 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. 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 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. 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. data: description: >- Type-specific information about the instrument. anyOf: - title: Card type: object description: Data specific to a Card 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 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 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' binLookup: description: >- Information about an issuer by the given BIN (or IIN). type: object required: - bin properties: bin: type: {} minLength: {} maxLength: {} description: {} example: {} network: type: {} description: {} enum: {} localNetwork: description: {} type: {} enum: {} issuer: type: {} description: {} issuerCountry: description: {} type: {} required: {} properties: {} segment: type: {} description: {} type: type: {} description: {} typeDetails: type: {} description: {} isNetworkToken: type: {} description: {} isFlexCard: type: {} description: {} billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. holderName: type: string description: Name of the owner of the Card. taxId: type: string description: >- Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument. - title: BankAccount type: object description: >- Data specific to a BankAccount instrument. properties: holder: type: object description: >- The data structure for a holder's personal information. properties: firstName: type: {} description: {} lastName: type: {} description: {} companyName: type: {} description: {} address: description: {} type: {} properties: {} email: type: {} format: {} description: {} dob: type: {} format: {} description: {} country: description: {} type: {} required: {} properties: {} city: type: {} description: {} type: type: {} enum: {} description: {} bank: type: object description: >- The data structure for a bank's information. properties: name: type: {} description: {} branchCode: type: {} description: {} code: type: {} description: {} address: description: {} type: {} properties: {} swiftCode: type: {} description: {} account: type: object description: >- The data structure for an account's information. properties: number: type: {} description: {} iban: type: {} description: {} currency: type: {} pattern: {} example: {} description: {} country: description: {} type: {} required: {} properties: {} type: type: {} enum: {} description: {} - title: PayPal type: object description: Data specific to a PayPal instrument. properties: email: type: string description: Email of the PayPal account. payerId: type: string description: ID of the PayPal payer account. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} - title: GooglePay type: object description: Data specific to a GooglePay instrument. allOf: - type: object required: - network - suffix properties: network: type: {} description: {} enum: {} networkDisplayName: type: {} description: {} binLookup: description: {} type: {} properties: {} billingAddress: description: {} type: {} properties: {} shippingAddress: description: {} type: {} properties: {} suffix: type: {} minLength: {} maxLength: {} description: {} expiryMonth: type: {} minLength: {} maxLength: {} description: {} expiryYear: type: {} minLength: {} maxLength: {} description: {} paymentToken: type: {} description: {} eci: type: {} description: {} cardHolderAuthenticated: type: {} description: {} - type: object properties: googleMessageId: type: {} description: {} googleMessageExpirationId: type: {} description: {} - title: ApplePay type: object description: Data specific to a ApplePay 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 networkDisplayName: type: string description: Display-friendly name of the network. binLookup: description: Information about an issuer. type: object properties: network: type: {} description: {} enum: {} localNetwork: description: {} type: {} enum: {} issuer: type: {} description: {} issuerCountry: description: {} type: {} required: {} properties: {} segment: type: {} description: {} type: type: {} description: {} typeDetails: type: {} description: {} isNetworkToken: type: {} description: {} isFlexCard: type: {} description: {} billingAddress: description: Billing Address of the instrument. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} shippingAddress: description: Shipping Address provided by the wallet. type: object properties: street: type: {} description: {} doorNumber: type: {} description: {} complement: type: {} description: {} area: type: {} description: {} city: type: {} description: {} postalCode: type: {} description: {} state: type: {} description: {} country: description: {} type: {} required: {} properties: {} latitude: type: {} format: {} description: {} longitude: type: {} format: {} description: {} phone: description: {} type: {} required: {} properties: {} alias: type: {} description: {} name: type: {} description: {} lastName: type: {} description: {} email: type: {} description: {} suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. paymentToken: type: string description: >- One-time payment token sent by client-side for execution of payment on backend. eci: type: string description: >- Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder. cardHolderAuthenticated: type: boolean description: >- Indicates that identification and verifications (ID&V) was performed on the returned payment credential. - title: DCB type: object description: Data specific to a DCB instrument. properties: msisdn: type: string description: >- Mobile number of the holder MSISDN Stands for Mobile Station International Subscriber Directory Number. msisdnTail: type: string description: >- Last 4 digits of the mobile number of the holder. country: description: Country of the holder. type: object required: - code properties: code: type: {} description: {} pattern: {} iso3: type: {} description: {} pattern: {} name: type: {} description: {} carrierNetwork: type: string description: Carrier network of the msisdn. - title: MBWay type: object description: Data specific to an MB WAY instrument. properties: phone: type: object description: >- Mobile number the payer confirms MB WAY payments with. properties: countryCode: type: {} description: {} example: {} number: type: {} description: {} example: {} - type: object properties: tokens: type: array description: >- Payment Instrument tokens used to execute the authorize operation. items: type: object properties: reference: type: string description: >- Unique identifier of the token in the provider's system. type: type: string description: Type of the token. enum: - network - vault - psp - networkOffers - networkGateway meta: description: >- Any provider-specific data that was stored for context in the token. type: object additionalProperties: true providerResponseAdditionalFields: type: object additionalProperties: true description: >- Any provider-specific response data requested by merchant on authorize. providerConfig: type: object description: >- Provider configuration details associated with this operation. properties: additionalData: type: object description: > Custom key-value data configured on the provider configuration. Do not store secrets, credentials, or personally identifiable information (PII). additionalProperties: type: string dispute: type: object description: >- Dispute related to the Workflow execution. required: - id - providerReference - amount - status - reason - network - createdAt properties: id: type: string format: uuid description: Unique identifier for a dispute entity. paymentId: type: string format: uuid description: >- Unique identifier for the payment related to the dispute. providerReference: type: string description: >- Unique identifier of the Dispute in an external system, e.g. PSP. 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount used to execute the operation. status: type: string description: Status of a Dispute. enum: - FraudAlert - RetrievalOpened - RetrievalChallenged - RetrievalExpired - RetrievalClosed - DisputeNotified - DisputeOpened - DisputeChallenged - DisputeWon - DisputeLost - DisputeExpired - DisputeAccepted - DisputeCancelled - ArbitrationOpened - ArbitrationWon - ArbitrationLost activityType: type: string description: > What happened in the dispute event that triggered this notification, as a normalized label. Use it to detect a change - an escalation to the chargeback stage, evidence becoming due, a defense outcome - without keeping your own copy of the dispute's previous state to compare against. The values come from the same vocabulary as the dispute activity timeline. Note the two surfaces can label the same event differently: this field always uses the detailed vocabulary, while the timeline returned by the activities endpoint uses a coarser one unless detailed activity types are enabled for your account. Treat this field as the authoritative label for a notification. This labels a single event rather than describing a difference between two. An update that changes nothing is still delivered and repeats the previous label, so deduplicate on the dispute identifier together with this value if repeated notifications matter to you. The field is absent when the event cannot be classified. enum: - ChargebackNotification - ChargebackReverseNotification - PreArbitrationNotification - ArbitrationNotification - EvidenceRequired - EvidenceSubmitted - DisputeUnderReview - IssuerCommentsReceived - RetrievalNotification - FraudReportNotification - RetrievalInformationRequired - RetrievalEvidenceSubmitted - RetrievalUnderReview - RetrievalLost - RetrievalResolved - FraudReportReceived - ChargebackRaised - ChargebackEvidenceSubmittedPreDebit - ChargebackEvidenceReady - ChargebackNotDefendable - ChargebackAccepted - PreArbitrationOpened - PreArbitrationUnderReview - PreArbitrationWon - PreArbitrationLost - PreArbitrationSecondChargeback - PreArbitrationAccepted - ArbitrationOpened - ArbitrationEvidenceSubmitted - ArbitrationUnderReview - ArbitrationWon - ArbitrationLost - ArbitrationAccepted - AcceptDispute - DefendDispute - SubmitEvidence - DisputeWon - DisputeLost - DisputeResolved chargebackStatus: type: string enum: - Incoming - Executed - Reversed - SecondChargeback - IssuerReponseTimeframeExpired - ArbitrationReversed description: Status of the chargeback. previous: type: object description: >- The values this event replaced. Present with null members on the first event of a dispute, when there was nothing to replace. Omitted entirely for providers that keep no dispute of their own, where there is no previous state to report. properties: stage: oneOf: - type: string enum: - Created - FraudReport - Retrieval - Chargeback - PreArbitration - Arbitration - Unknown description: Stage of the dispute. - type: 'null' defenseStatus: oneOf: - type: string enum: - NotDefendable - Undefended - ReadyToSubmit - Submitted - Failed - UnderReview - Won - Lost - Accepted - Resolved - Unknown description: Status of the defense. - type: 'null' chargebackStatus: oneOf: - type: string enum: - Incoming - Executed - Reversed - SecondChargeback - IssuerReponseTimeframeExpired - ArbitrationReversed description: Status of the chargeback. - type: 'null' tags: type: array description: >- Names of the tags currently attached to the dispute. Omitted when the dispute has no tags. items: type: string reason: type: string description: >- Reason description indicating why the dispute was raised. reasonCode: type: string description: >- Reason code indicating why the dispute was raised. 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 createdAt: type: string format: date-time description: >- Exact date and time when the Dispute was created. retries: type: object description: >- Information about an action retry. Present if the action failed, and a retry is scheduled. properties: startedAt: type: string format: date-time description: >- Time when the retry is set up, but not performed yet. When it is scheduled to be perform can be checked in 'nextScheduledAt'. completedAttempts: type: integer description: >- Number of retry attempts completed so far. nextScheduledAt: type: string format: date-time description: >- Time when the next retry attempt will be performed. stopReason: type: string description: Reason for stopping further retries. idempotencyKey: type: string format: uuid description: >- Idempotency key used to retry in case of timeout. captureMode: description: >- Capture mode used for the payment operation. type: string enum: - Instant - Manual - Delayed - type: object properties: payoutId: description: >- Unique identifier of the Payout affected during execution of the operation. type: string format: uuid - type: object title: executionActionPending description: Execution action pending. required: - execution - action properties: action: type: string description: The type of pending action. enum: - authorize - confirm - capture - cancel - refund actionId: type: string format: uuid description: >- The unique action execution identifier originally returned in the synchronous action response. execution: type: object description: >- The Workflow execution for which action is pending. required: - workflowCode - id - merchantReference - holderReference - meta properties: workflowCode: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. id: type: string format: uuid description: ID of Workflow execution. merchantReference: type: string description: >- Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system. holderReference: type: string description: >- Merchant-provided reference for the transaction counterparty, i.e. the paying consumer. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. requiredAction: type: object description: >- Details of the next possible actions that can be taken. required: - type properties: type: type: string enum: - redirect - confirm - review - wait description: Type of the required action. subType: type: string enum: - merchant - client - internal description: Sub type of the required action. description: type: string description: Details of the required action. href: type: string description: URL to complete the required action. method: type: string description: >- HTTP method that should be used to call the `href`. enum: - GET - POST - PUT - PATCH - DELETE clientConfig: type: object description: >- Details for the client to indicate how an action needs to be performed. properties: renderMode: type: string enum: - hidden description: >- Indicates the visibility of the action when being performed on the client. action: type: object description: >- Details of a prerequisite action, which needs to be executed prior calling the provided link. additionalProperties: true 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The total amount used during execution of the action. paymentComposition: type: array description: >- List of Payment Methods that were affected by the action. items: type: object required: - integrationType - amount - operationType properties: operationType: type: string description: >- Operation Type that was executed in the Provider. enum: - Authorize - Preauthorize - Capture - Cancel - Refund - Credit - SendNotification - CaptureNotification - RefundNotification - CancelNotification - AuthorizeNotification - ChargebackNotification - ChargebackReverseNotification - Get - Search - GetToken - Tokenize - DisableToken - Register - Generate3DS - Validate3DS - PayerAuthInit - PayerAuthCheckEnroll - PayerAuthValidate - RefundFailedNotification - RefundReversedNotification - CaptureFailedNotification - ValidateRedirect - RefundNotificationUpdated integrationType: type: string enum: - api - hpp - inperson description: >- Code of the integration type for using the payment method in the provider. paymentMethodCode: type: string enum: - alexBankMa7fazty - amazonPay - applePay - audi2pay - alfa - alipay - bankTransfer - card - 2c2p - capitecPay - cibSmartWallet - easypaisa - etisalatCash - fawryMobileWallet - fawryPay - googlePay - jazzCash - mercadoPago - monoDirectDebit - nbePhoneCash - orangeCash - oPayWallet - pagaWallet - payflex - payjustnow - payPal - pix - konnect - qnbEWallet - wafaCashWallet - weCash - genericRedirect - eftPro - upi - cashFreeWallet - paytmMWallet - netBanking - meezaWallet - vodafoneCash - alipayQRCode - sepaDirectDebit - dcb - bankAccount - modo - ach - payzoneCash - revolutPay - lean - tabby - boleto - oxxo - spei - promptPay - qris - momoVN - vietQR - konbini - touchNGo - gCash - maya - pse - pagoEfectivo - napas - duitNowQR - grabPay - shopeePay - nequi - picPay - ovo - trueMoney - iDeal - bancontact - khipu - razerGold - webPay - smartPix - venmo - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - knet - scalapay - bizum description: >- Code of the payment method selected to perform the payment. paymentInstrumentId: type: string format: uuid description: >- Unique identifier of the Payment Instrument that the customer selected for the Payment. storeInstrument: type: boolean description: >- Holder intention to store the payment instrument on authorize. paymentId: description: >- Unique identifier of the Payment affected during execution of the operation. type: string format: uuid 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. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. description: >- The amount used to execute the operation. success: type: boolean description: >- Operation outcome. If `true`, then the operation was finished successfully, and `false` otherwise. operationResult: type: string description: >- Result of the Operation according to Payrails mapping from the provider response. enum: - Success - Accepted - Pending - HTTPRedirectRequired - FormRedirectRequired - Unknown - UnexpectedProviderResponse - ProviderUnknownError - ProviderConnectionError - Timeout - ProviderTimeout - GenericRejection - FraudRisk - DuplicateOperation - OperationNotAllowed - InstrumentNotAllowed - InvalidInstrument - InsufficientBalance - BlockedInstrument - ExpiredInstrument - ValidationError - ParamsError - ProviderConfigError - InvalidSignature - InternalServerError - PayerCanceled - AuthenticationError - AuthenticationRequired - LimitExceeded - PaymentMethodNotSupported - AuthorizationRevoked providerId: type: string format: uuid description: >- Unique identifier of the provider used to execute the operation. provider: description: Provider used to execute the operation. type: object required: - id - name - displayName - type - createdAt - configSchema properties: id: type: string description: Unique identifier of the provider. format: uuid name: type: string description: Name of the provider. displayName: type: string description: Display name of the provider. type: type: string description: Provider type. enum: - Fraud - Payment - Payout - Vault - NetworkOffers - ThreeDS - NetworkGateway - NetworkToken - Bin - Data - Dispute - DisputeAlert - Tax - Billing status: type: string description: Status of the provider. enum: - active - inactive configSchema: type: string description: >- JSON schema of the provider configuration. selfOnboarding: type: object description: >- Self-onboarding capabilities available for this provider. properties: enabled: type: boolean description: >- Whether self-onboarding is enabled for this provider. supportedAuthModes: type: array description: >- Authentication modes supported for self-onboarding. items: type: string enum: - none - oauth notificationURLTemplate: type: string description: > Template of the notification URL for provider configs of that provider. The template contains variables between curly braces that can be mapped to the fields of the provider configs (e.g. `{id}`, `{accountName}`) and substituted to generate the notification URL of that provider config. createdAt: type: string format: date-time description: Date of creation of the provider. updatedAt: type: string format: date-time description: Last update of the provider. providerConfigId: type: string format: uuid description: >- Unique identifier of the provider configuration used to execute the operation. operationProviderReference: type: string description: >- Reference of the operation in the provider's system. errors: type: array description: >- The reason why the operation was not successful, set if `success = false`. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. accountFundingTransaction: type: boolean description: >- Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer. authorizationCode: type: string description: >- The acquirer authorization code if the payment was authorized. acquirerMID: type: string description: >- Merchant Identifier (MID) on the acquirer that processed the payment. acquirerAccountCode: type: string description: >- Account Code on the acquirer that processed the payment. acquirerCountryCode: type: string description: >- Country Code on the acquirer that processed the payment. avsResultCode: type: string description: > Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check. - `Y`: address and postal code both match. - `A`: address matches, postal code does not. - `Z`: postal code matches, address does not. - `N`: neither address nor postal code match. - `U`: the issuer could not perform the check. cvvResultCode: type: string description: > Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check. - `M`: security code matched. - `N`: security code did not match. - `U`: the issuer could not perform the check. - `P`: the check was expected but not processed. acquirerReference: type: string description: >- Acquirer Reference Number (ARN) assigned to the payment by the issuer. providerReference: type: string description: >- Unique identifier of the Payment in an external system, e.g. PSP. retrievalReference: type: string description: >- Retrieval Reference Number (RRN) assigned to the payment by the issuer. paymentInstrument: type: object description: >- Payment Instrument and tokens used to execute the authorize operation. allOf: - type: object required: - id - holderId - paymentMethod - status - createdAt - updatedAt properties: id: type: string format: uuid description: Id of the instrument. createdAt: type: string format: date-time description: >- Date and time when the Instrument was created in Payrails. updatedAt: type: string format: date-time description: When the Instrument was last updated. holderId: type: string format: uuid description: >- Unique identifier of the Holder in Payrails. 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 - cashFreeWallet - paytmWallet - phonePe - iDeal - bancontact - klarnaPayLater - klarnaPayNow - klarnaPayOverTime - scalapay status: type: string description: Status of the instrument. enum: - created - deleted - enabled - disabled - transient displayName: type: string description: Instrument name suitable for display. description: type: string description: Description of the instrument. default: type: boolean description: >- True if this instrument is set as default for the holder. nullable: true merchantReference: type: string description: >- Merchant-provided reference for the instrument. 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. 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 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. 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. data: description: >- Type-specific information about the instrument. anyOf: - title: Card type: object description: Data specific to a Card 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 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 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' 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' 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 localNetwork: description: >- Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact. type: string enum: - bancontact - cartesbancaires - dankort - mada issuer: type: string description: >- Name of the bank or institution that issued the card. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. segment: type: string description: >- Segment of the card, e.g. gold, black, business. type: type: string description: >- Type of the card, e.g. credit, debit, prepaid, gift. typeDetails: type: string description: >- More information about the card type, e.g. personal, commercial. isNetworkToken: type: boolean description: > Indicates whether the card credential represents a network token rather than a primary account number (PAN). 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. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. holderName: type: string description: Name of the owner of the Card. taxId: type: string description: >- Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument. - title: BankAccount type: object description: >- Data specific to a BankAccount 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. lastName: type: string description: The last name of the account holder. companyName: type: string description: The company name for business holders. address: description: The address of the account holder. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. email: type: string format: email description: The email address of the account holder. dob: type: string format: date description: >- The date of birth of the account holder (YYYY-MM-DD). 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. city: type: string description: The city of the account holder. type: type: string enum: - individual - corporate description: The type of account holder. bank: type: object description: >- The data structure for a bank's information. properties: name: type: string description: The name of the bank. branchCode: type: string description: The branch code of the bank. code: type: string description: The bank code. address: description: The address of the bank. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. swiftCode: type: string description: The SWIFT/BIC code of the bank. account: type: object description: >- The data structure for an account's information. properties: number: type: string description: The bank account number. iban: type: string description: >- The International Bank Account Number (IBAN). currency: type: string pattern: ^[A-Z]{3}$ example: USD description: ISO 3-letter currency code. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. type: type: string enum: - savings - current description: The type of bank account. - title: PayPal type: object description: Data specific to a PayPal instrument. properties: email: type: string description: Email of the PayPal account. payerId: type: string description: ID of the PayPal payer account. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. - title: GooglePay type: object description: Data specific to a GooglePay instrument. allOf: - type: object 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 networkDisplayName: type: string description: Display-friendly name of the network. 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 localNetwork: description: >- Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact. type: string enum: - bancontact - cartesbancaires - dankort - mada issuer: type: string description: >- Name of the bank or institution that issued the card. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. segment: type: string description: >- Segment of the card, e.g. gold, black, business. type: type: string description: >- Type of the card, e.g. credit, debit, prepaid, gift. typeDetails: type: string description: >- More information about the card type, e.g. personal, commercial. isNetworkToken: type: boolean description: > Indicates whether the card credential represents a network token rather than a primary account number (PAN). 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. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. shippingAddress: description: Shipping Address provided by the wallet. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. paymentToken: type: string description: >- One-time payment token sent by client-side for execution of payment on backend. eci: type: string description: >- Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder. cardHolderAuthenticated: type: boolean description: >- Indicates that identification and verifications (ID&V) was performed on the returned payment credential. - type: object properties: googleMessageId: type: string description: >- Unique identifier for the Google Pay message. googleMessageExpirationId: type: string description: >- Expiration time for the Google Pay message. - title: ApplePay type: object description: Data specific to a ApplePay 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 networkDisplayName: type: string description: Display-friendly name of the network. 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 localNetwork: description: >- Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact. type: string enum: - bancontact - cartesbancaires - dankort - mada issuer: type: string description: >- Name of the bank or institution that issued the card. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. segment: type: string description: >- Segment of the card, e.g. gold, black, business. type: type: string description: >- Type of the card, e.g. credit, debit, prepaid, gift. typeDetails: type: string description: >- More information about the card type, e.g. personal, commercial. isNetworkToken: type: boolean description: > Indicates whether the card credential represents a network token rather than a primary account number (PAN). 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. billingAddress: description: Billing Address of the instrument. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. shippingAddress: description: Shipping Address provided by the wallet. type: object properties: street: type: string description: >- The name of the street of a postal address. doorNumber: type: string description: >- The number on the door, building, or room. complement: type: string description: >- Additional addressing information, 2nd line of postal address. area: type: string description: >- The name of the suburb or area within a city. city: type: string description: >- The name of the city of a postal address. postalCode: type: string description: The postal code. state: type: string description: >- The name of the state a postal address is in. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. latitude: type: number format: float description: >- Latitude of the address in the GPS coordinate system. longitude: type: number format: float description: >- Longitude of the address in the GPS coordinate system. phone: description: >- The phone to contact in the address (can be different that the customer's). type: object required: - number properties: countryCode: type: string pattern: ^\+?[0-9]+$ description: >- International prefix of the phone, if known separately. number: type: string pattern: ^[0-9]+$ description: >- The local number of the phone, such that `countryCode` + `number` can be dialed. alias: type: string description: Name of the address, e.g. home, work. name: type: string description: >- Name of the person to whom the address belongs to. lastName: type: string description: >- Last name of the person to whom the address belongs to. email: type: string description: >- Email of the person to whom the address belongs to. suffix: type: string minLength: 4 maxLength: 4 description: Last digits of the Card number. expiryMonth: type: string minLength: 2 maxLength: 2 description: Expiry month of the Card. expiryYear: type: string minLength: 4 maxLength: 4 description: Expiry year of the Card. paymentToken: type: string description: >- One-time payment token sent by client-side for execution of payment on backend. eci: type: string description: >- Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder. cardHolderAuthenticated: type: boolean description: >- Indicates that identification and verifications (ID&V) was performed on the returned payment credential. - title: DCB type: object description: Data specific to a DCB instrument. properties: msisdn: type: string description: >- Mobile number of the holder MSISDN Stands for Mobile Station International Subscriber Directory Number. msisdnTail: type: string description: >- Last 4 digits of the mobile number of the holder. 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}$ iso3: type: string description: >- ISO 3-letter country code. Returned by Payrails, but not interpreted in requests. pattern: ^[A-Z]{3}$ name: type: string description: >- The English name of the country. Returned by Payrails, but not interpreted in requests. carrierNetwork: type: string description: Carrier network of the msisdn. - title: MBWay type: object description: Data specific to an MB WAY 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' number: type: string description: National number, digits only. example: '912345678' - type: object properties: tokens: type: array description: >- Payment Instrument tokens used to execute the authorize operation. items: type: object properties: reference: type: string description: >- Unique identifier of the token in the provider's system. type: type: string description: Type of the token. enum: - network - vault - psp - networkOffers - networkGateway meta: description: >- Any provider-specific data that was stored for context in the token. type: object additionalProperties: true providerResponseAdditionalFields: type: object additionalProperties: true description: >- Any provider-specific response data requested by merchant on authorize. reason: type: string enum: - BetterPrice - CustomerDontNeed - DamagedProduct - Duplicate - FraudulentProduct - LateDelivery - NoReason - ProductMismatchDescription - WrongProduct - WrongProductSpecification description: Reason for invoking the operation or action. reasonDescription: type: string description: >- Reason description specified when the action was initiated. example: Customer's order expired. errors: type: array description: >- The main reason why the action was not successful, set if `success = false`. 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. - title: executionActionStepScheduled type: object description: >- Details for an executionActionStepScheduled event. Emitted when a workflow action step is scheduled for future execution. allOf: - type: object description: >- Common fields shared by workflow execution step events. required: - action - step - workflow properties: action: type: object description: >- Parent workflow action that invoked the step execution. required: - type - id - triggerType properties: type: type: string description: Type of workflow action. enum: - lookup - authorize - capture - refund - cancel - payout - orderUpdate id: type: string format: uuid description: >- Unique identifier of the workflow action. triggerType: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external step: allOf: - type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS - type: object properties: previousStep: type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS actionStepType: type: string description: >- Type of workflow action step executed within a workflow. enum: - authorize - capture - refund - cancel - payout - fraudScore - lookup - fraudUpdate - notify - createInstrument - provisionNetworkToken - threeDS - tagDispute - assignDispute - scoreDispute - defendDispute triggerStepType: type: string description: Specifies the API type for the trigger. enum: - clientAPI - merchantAPI - event triggerStepEventName: type: string description: >- The name of the event that triggers the workflow. enum: - DisputeUpdated - PaymentStatusUpdated workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. - type: object properties: output: type: object description: >- Additional information about why the step was scheduled and when it will be executed (e.g. retry scheduling details). additionalProperties: true - title: executionActionStepUnscheduled type: object description: >- Details for an executionActionStepUnscheduled event. Emitted when a previously scheduled workflow action step is removed from the execution schedule. allOf: - type: object description: >- Common fields shared by workflow execution step events. required: - action - step - workflow properties: action: type: object description: >- Parent workflow action that invoked the step execution. required: - type - id - triggerType properties: type: type: string description: Type of workflow action. enum: - lookup - authorize - capture - refund - cancel - payout - orderUpdate id: type: string format: uuid description: >- Unique identifier of the workflow action. triggerType: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external step: allOf: - type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS - type: object properties: previousStep: type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS actionStepType: type: string description: >- Type of workflow action step executed within a workflow. enum: - authorize - capture - refund - cancel - payout - fraudScore - lookup - fraudUpdate - notify - createInstrument - provisionNetworkToken - threeDS - tagDispute - assignDispute - scoreDispute - defendDispute triggerStepType: type: string description: Specifies the API type for the trigger. enum: - clientAPI - merchantAPI - event triggerStepEventName: type: string description: >- The name of the event that triggers the workflow. enum: - DisputeUpdated - PaymentStatusUpdated workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. - type: object properties: output: type: object description: >- Additional information about why the step was unscheduled. additionalProperties: true - title: executionActionStepRequested type: object description: >- Details for an executionActionStepRequested event. Emitted when a workflow action step is requested and about to begin processing. allOf: - type: object description: >- Common fields shared by workflow execution step events. required: - action - step - workflow properties: action: type: object description: >- Parent workflow action that invoked the step execution. required: - type - id - triggerType properties: type: type: string description: Type of workflow action. enum: - lookup - authorize - capture - refund - cancel - payout - orderUpdate id: type: string format: uuid description: >- Unique identifier of the workflow action. triggerType: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external step: allOf: - type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS - type: object properties: previousStep: type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS actionStepType: type: string description: >- Type of workflow action step executed within a workflow. enum: - authorize - capture - refund - cancel - payout - fraudScore - lookup - fraudUpdate - notify - createInstrument - provisionNetworkToken - threeDS - tagDispute - assignDispute - scoreDispute - defendDispute triggerStepType: type: string description: Specifies the API type for the trigger. enum: - clientAPI - merchantAPI - event triggerStepEventName: type: string description: >- The name of the event that triggers the workflow. enum: - DisputeUpdated - PaymentStatusUpdated workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. - type: object required: - input properties: input: type: object description: >- The input data provided to the step at the time of the request. additionalProperties: true - title: executionActionStepStarted type: object description: >- Details for an executionActionStepStarted event. Emitted when a workflow action step begins active execution. allOf: - type: object description: >- Common fields shared by workflow execution step events. required: - action - step - workflow properties: action: type: object description: >- Parent workflow action that invoked the step execution. required: - type - id - triggerType properties: type: type: string description: Type of workflow action. enum: - lookup - authorize - capture - refund - cancel - payout - orderUpdate id: type: string format: uuid description: >- Unique identifier of the workflow action. triggerType: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external step: allOf: - type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS - type: object properties: previousStep: type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS actionStepType: type: string description: >- Type of workflow action step executed within a workflow. enum: - authorize - capture - refund - cancel - payout - fraudScore - lookup - fraudUpdate - notify - createInstrument - provisionNetworkToken - threeDS - tagDispute - assignDispute - scoreDispute - defendDispute triggerStepType: type: string description: Specifies the API type for the trigger. enum: - clientAPI - merchantAPI - event triggerStepEventName: type: string description: >- The name of the event that triggers the workflow. enum: - DisputeUpdated - PaymentStatusUpdated workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. - type: object required: - input properties: input: type: object description: >- The input data provided to the step at the time of execution start. additionalProperties: true - title: executionActionStepPaused type: object description: >- Details for an executionActionStepPaused event. Emitted when a workflow action step is paused mid-execution, for example while waiting for a notification or a required action completion. allOf: - type: object description: >- Common fields shared by workflow execution step events. required: - action - step - workflow properties: action: type: object description: >- Parent workflow action that invoked the step execution. required: - type - id - triggerType properties: type: type: string description: Type of workflow action. enum: - lookup - authorize - capture - refund - cancel - payout - orderUpdate id: type: string format: uuid description: >- Unique identifier of the workflow action. triggerType: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external step: allOf: - type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS - type: object properties: previousStep: type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS actionStepType: type: string description: >- Type of workflow action step executed within a workflow. enum: - authorize - capture - refund - cancel - payout - fraudScore - lookup - fraudUpdate - notify - createInstrument - provisionNetworkToken - threeDS - tagDispute - assignDispute - scoreDispute - defendDispute triggerStepType: type: string description: Specifies the API type for the trigger. enum: - clientAPI - merchantAPI - event triggerStepEventName: type: string description: >- The name of the event that triggers the workflow. enum: - DisputeUpdated - PaymentStatusUpdated workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. - type: object properties: output: type: object description: >- Additional information about why the step was paused (e.g. awaiting notification or required action result). additionalProperties: true - title: executionActionStepResumed type: object description: >- Details for an executionActionStepResumed event. Emitted when a previously paused workflow action step resumes execution, for example after receiving a notification or a required action result. allOf: - type: object description: >- Common fields shared by workflow execution step events. required: - action - step - workflow properties: action: type: object description: >- Parent workflow action that invoked the step execution. required: - type - id - triggerType properties: type: type: string description: Type of workflow action. enum: - lookup - authorize - capture - refund - cancel - payout - orderUpdate id: type: string format: uuid description: >- Unique identifier of the workflow action. triggerType: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external step: allOf: - type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS - type: object properties: previousStep: type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS actionStepType: type: string description: >- Type of workflow action step executed within a workflow. enum: - authorize - capture - refund - cancel - payout - fraudScore - lookup - fraudUpdate - notify - createInstrument - provisionNetworkToken - threeDS - tagDispute - assignDispute - scoreDispute - defendDispute triggerStepType: type: string description: Specifies the API type for the trigger. enum: - clientAPI - merchantAPI - event triggerStepEventName: type: string description: >- The name of the event that triggers the workflow. enum: - DisputeUpdated - PaymentStatusUpdated workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. - type: object properties: output: type: object description: >- Additional information about why the step was resumed (e.g. notification received or required action result is available). additionalProperties: true - title: executionActionStepCompleted type: object description: >- Details for an executionActionStepCompleted event. Emitted when a workflow action step finishes execution, either successfully or with an error. allOf: - type: object description: >- Common fields shared by workflow execution step events. required: - action - step - workflow properties: action: type: object description: >- Parent workflow action that invoked the step execution. required: - type - id - triggerType properties: type: type: string description: Type of workflow action. enum: - lookup - authorize - capture - refund - cancel - payout - orderUpdate id: type: string format: uuid description: >- Unique identifier of the workflow action. triggerType: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external step: allOf: - type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS - type: object properties: previousStep: type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS actionStepType: type: string description: >- Type of workflow action step executed within a workflow. enum: - authorize - capture - refund - cancel - payout - fraudScore - lookup - fraudUpdate - notify - createInstrument - provisionNetworkToken - threeDS - tagDispute - assignDispute - scoreDispute - defendDispute triggerStepType: type: string description: Specifies the API type for the trigger. enum: - clientAPI - merchantAPI - event triggerStepEventName: type: string description: >- The name of the event that triggers the workflow. enum: - DisputeUpdated - PaymentStatusUpdated workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. - type: object properties: output: type: object description: >- The output data produced by the step upon completion. additionalProperties: true error: 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. - title: executionActionStepUpdated type: object description: >- Details for an executionActionStepUpdated event. Emitted when a workflow action step is updated with intermediate output during execution. allOf: - type: object description: >- Common fields shared by workflow execution step events. required: - action - step - workflow properties: action: type: object description: >- Parent workflow action that invoked the step execution. required: - type - id - triggerType properties: type: type: string description: Type of workflow action. enum: - lookup - authorize - capture - refund - cancel - payout - orderUpdate id: type: string format: uuid description: >- Unique identifier of the workflow action. triggerType: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external step: allOf: - type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS - type: object properties: previousStep: type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS actionStepType: type: string description: >- Type of workflow action step executed within a workflow. enum: - authorize - capture - refund - cancel - payout - fraudScore - lookup - fraudUpdate - notify - createInstrument - provisionNetworkToken - threeDS - tagDispute - assignDispute - scoreDispute - defendDispute triggerStepType: type: string description: Specifies the API type for the trigger. enum: - clientAPI - merchantAPI - event triggerStepEventName: type: string description: >- The name of the event that triggers the workflow. enum: - DisputeUpdated - PaymentStatusUpdated workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. - type: object properties: output: type: object description: >- The intermediate output data produced by the step update. additionalProperties: true error: 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. - title: executionTriggerStepCalled type: object description: >- Details for an executionTriggerStepCalled event. Emitted when a workflow trigger step is called, capturing both the input that initiated the trigger and the resulting output. allOf: - type: object description: >- Common fields shared by workflow execution step events. required: - action - step - workflow properties: action: type: object description: >- Parent workflow action that invoked the step execution. required: - type - id - triggerType properties: type: type: string description: Type of workflow action. enum: - lookup - authorize - capture - refund - cancel - payout - orderUpdate id: type: string format: uuid description: >- Unique identifier of the workflow action. triggerType: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external step: allOf: - type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS - type: object properties: previousStep: type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS actionStepType: type: string description: >- Type of workflow action step executed within a workflow. enum: - authorize - capture - refund - cancel - payout - fraudScore - lookup - fraudUpdate - notify - createInstrument - provisionNetworkToken - threeDS - tagDispute - assignDispute - scoreDispute - defendDispute triggerStepType: type: string description: Specifies the API type for the trigger. enum: - clientAPI - merchantAPI - event triggerStepEventName: type: string description: >- The name of the event that triggers the workflow. enum: - DisputeUpdated - PaymentStatusUpdated workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. - type: object required: - input - output properties: input: type: object description: >- The input data that triggered the workflow step. additionalProperties: true output: type: object description: >- The output data produced by the trigger step call. additionalProperties: true - title: executionConditionStepEvaluated type: object description: >- Details for an executionConditionStepEvaluated event. Emitted when a workflow condition step is evaluated, containing the evaluation context and the resulting decision. allOf: - type: object description: >- Common fields shared by workflow execution step events. required: - action - step - workflow properties: action: type: object description: >- Parent workflow action that invoked the step execution. required: - type - id - triggerType properties: type: type: string description: Type of workflow action. enum: - lookup - authorize - capture - refund - cancel - payout - orderUpdate id: type: string format: uuid description: >- Unique identifier of the workflow action. triggerType: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external step: allOf: - type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS - type: object properties: previousStep: type: object description: Summary of a workflow step. required: - id - type - name - code properties: id: type: string format: uuid description: Unique identifier of the workflow step. type: type: string description: >- Defines the type of operation to be executed. Each type has a different set of parameters. enum: - trigger - action - condition name: type: string description: >- Human-readable name of the workflow step. example: Authorize with 3DS code: type: string description: >- Machine-readable code of the workflow step. example: authorizeWithThreeDS actionStepType: type: string description: >- Type of workflow action step executed within a workflow. enum: - authorize - capture - refund - cancel - payout - fraudScore - lookup - fraudUpdate - notify - createInstrument - provisionNetworkToken - threeDS - tagDispute - assignDispute - scoreDispute - defendDispute triggerStepType: type: string description: Specifies the API type for the trigger. enum: - clientAPI - merchantAPI - event triggerStepEventName: type: string description: >- The name of the event that triggers the workflow. enum: - DisputeUpdated - PaymentStatusUpdated workflow: type: object description: >- Workflow template from which the Executions are created. required: - code - version properties: code: type: string pattern: ^[a-z][-A-Za-z0-9]*$ description: Machine-friendly code of Workflow. version: type: integer description: Version of a Workflow Configuration. - type: object required: - context - result properties: context: type: object description: >- The execution context used when evaluating the condition. properties: 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/payment-acceptance/meta-fields). See [Meta](/reference/meta) for every field. dynamic: type: object description: >- Additional computed metadata available during evaluation. additionalProperties: true result: type: object description: The outcome of the condition evaluation. properties: matched: type: boolean description: Whether the condition was matched. ruleId: type: string format: uuid description: >- The identifier of the rule that was matched, if any. workspaceId: type: string format: uuid description: Workspace ID that the event belongs to. eventTrigger: type: string description: > Specify what triggered the event. * `api` - Event was triggered through an API request. * `action` - Event was triggered as a result of another action. * `external` - Event was triggered outside of Payrails. enum: - api - action - external notificationEvent: type: object title: notification event. required: - workflowCode - workflowExecutionId - workflowExecutionEventId - workspaceId - status - createdAt - updatedAt properties: id: type: string description: Unique identifier of the Notification event. format: uuid workflowExecutionId: type: string description: >- Unique identifier of the Workflow Execution that this notification event belongs to. workflowCode: type: string description: Workflow code. workflowExecutionEventId: type: string format: uuid description: >- Unique identifier of the Workflow Execution Event that this notification event belongs to. workspaceId: type: string format: uuid description: >- Unique identifier of the Workspace that this notification event belongs to. status: type: string description: Value of Notification event status enumeration. enum: - delivered - deliveryFailed - pending body: type: string description: Original body request object sent. createdAt: type: string format: date-time description: Date of creation of the Notification. updatedAt: type: string format: date-time description: Last update of the Notification. example: events: - notificationEvent: id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 workflowCode: payment-acceptance workflowExecutionId: 8a780068-bf6b-4ba1-9b24-d32606b2fc19 workflowExecutionEventId: 42dc198e-fee0-45e9-aaa6-765036a15ade workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a createdAt: '2022-02-03T14:38:40.557Z' updatedAt: '2022-02-03T14:38:40.557Z' status: delivered body: >- {"action":"authorize","actionId":"71f9cfed-1583-4483-b5d8-49af91749d85","amount":{"currency":"EUR","value":"22.50"},"execution":{"id":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","holderId":"fe8397fc-3301-4ffa-b0bc-b7f83e835a64","holderReference":"84c51416-e06c-4dff-a76f-72fd66f3182d","merchantReference":"679b48ed-ae78-48ae-b19a-460b52c2354d"}} event: executionActionCompleted time: '2022-04-22T17:53:36.814Z' details: action: authorize actionId: 1aa0ef20-36cb-4485-b60e-0526c3699014 execution: workflowCode: d5454c2f-ae5e-44f3-8edf-f6dad64f005f id: c5454c2f-ae5e-44f3-8edf-e6dad64f006f merchantReference: order_3573894940903 holderReference: customer123 meta: order: reference: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios success: true amount: value: '12.50' currency: EUR paymentComposition: - operationType: Authorize amount: currency: EUR value: '24.00' integrationType: api operationResult: Success operationProviderReference: provider-reference-example providerId: 5eb08624-ecce-4cbc-9a8a-61d484172815 provider: id: 5eb08624-ecce-4cbc-9a8a-61d484172815 name: checkout displayName: Checkout.com type: Payment status: active configSchema: >- {"required":["accountDetails","credentials"],"definitions":{"PspCheckoutAccountDetails":{"required":["processingChannelId"],"properties":{"processingChannelId":{"title":"Processing channel ID","minLength":1,"pattern":"^pc_.+$","type":"string"}},"type":"object"},"PspCheckoutCredentials":{"required":["clientId","clientSecret"],"properties":{"clientId":{"title":"Client ID","description":"Client ID used to authenticate requests to the Checkout API","minLength":1,"type":"string"},"clientSecret":{"title":"Client Secret","description":"Client Secret used to authenticate requests to the Checkout API","minLength":1,"type":"string","format":"secret"},"hmacKeys":{"title":"HMAC keys","description":"HMAC keys used to authenticate notifications from the Checkout API","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","items":{"type":"string"},"type":"array","format":"secret"}},"type":"object"}},"properties":{"accountDetails":{"$ref":"#/definitions/PspCheckoutAccountDetails","title":"Account details"},"credentials":{"$ref":"#/definitions/PspCheckoutCredentials","title":"Checkout credentials"}},"type":"object"} createdAt: '2021-01-05T10:20:00.000Z' updatedAt: '2022-06-14T11:50:00.000Z' providerConfigId: a0ad4cd3-f243-4f1a-b294-f7c3df701b10 paymentId: c9e1a8ea-a0de-42bd-bcfd-46d3f437b5fe paymentInstrumentId: a4a7ed2d-bdcc-46a3-a9f2-701b5d7924b0 storeInstrument: true paymentMethodCode: card accountFundingTransaction: true authorizationCode: X055258 acquirerReference: '1233524535345' providerReference: '1027724325777' retrievalReference: '8657867867867' acquirerAccountCode: MI21 acquirerCountryCode: NL acquirerMID: 50TP avsResultCode: 'Y' cvvResultCode: M success: true workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a paymentInstrument: tokens: - type: psp reference: provider-token meta: holderReference: provider-customer-reference id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 holderId: 788c7c09-a490-4603-915a-e2a957a6cca1 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' paymentMethod: card displayName: Visa **** 1111 description: Personal card. merchantReference: ref_C47C47 fingerprint: 739abff0-406a-4d32-8cfb-701e12be5848 status: created futureUsage: CardOnFile networkTransactionReference: '987654321234567' data: network: visa bin: '416598' binLookup: bin: '416598' network: visa localNetwork: bancontact issuer: Revolut issuerCountry: code: LT name: Lithuania iso3: LTU segment: infinite type: debit typeDetails: personal suffix: '1111' expiryMonth: '10' expiryYear: '2026' holderName: John Doe billingAddress: country: code: DE name: Germany postalCode: '10117' captureMode: Instant workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: api - event: ruleEngineExecuted time: '2022-02-03T14:34:44.857Z' details: action: determineProviderOptions context: meta: order: reference: '******' customer: reference: '******' clientContext: ipAddress: '******' rulesets: - id: 670e7a35-c282-469f-b77f-336b75bcbe55 version: 1 createdAt: '2022-11-02T12:27:22.73972022Z' trigger: 'on': determineProviderOptions filter: providerConfigID: 5eb08624-ecce-4cbc-9a8a-61d484172815 rules: - condition: field: customer.country.code operator: '=' value: DE action: type: setPriority params: priority: 1 defaultAction: type: skip workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a evaluations: - chosenRule: condition: field: customer.country.code operator: '=' value: DE action: type: setPriority params: priority: 1 action: type: setPriority params: priority: 1 ruleEvaluationResults: - rule: condition: field: customer.country.code operator: '=' value: DE action: type: setPriority params: priority: 1 result: true entity: id: d9479775-3926-44af-9fcc-1c83ff4dcad6 providerId: 01039f19-d151-48b4-86aa-b36e68323e4e createdAt: '2022-04-22T17:53:36.814Z' config: accountDetails: processingChannelId: pc_0a70d769-9c20-416e-a436-4a323ce7eabf credentials: clientId: ack_3b2105ac-0190-4e18-a46c-d79ff97a39bc clientSecret: >- secret://**********************************************************************************XYZA hmacKeys: - >- secret://********************************67X9 accountName: TestAccountName configSchema: >- {"required":["accountDetails","credentials"],"definitions":{"PspCheckoutAccountDetails":{"required":["processingChannelId"],"properties":{"processingChannelId":{"title":"Processing channel ID","minLength":1,"pattern":"^pc_.+$","type":"string"}},"type":"object"},"PspCheckoutCredentials":{"required":["clientId","clientSecret"],"properties":{"clientId":{"title":"Client ID","description":"Client ID used to authenticate requests to the Checkout API","minLength":1,"type":"string"},"clientSecret":{"title":"Client Secret","description":"Client Secret used to authenticate requests to the Checkout API","minLength":1,"type":"string","format":"secret"},"hmacKeys":{"title":"HMAC keys","description":"HMAC keys used to authenticate notifications from the Checkout API","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","items":{"type":"string"},"type":"array","format":"secret"}},"type":"object"}},"properties":{"accountDetails":{"$ref":"#/definitions/PspCheckoutAccountDetails","title":"Account details"},"credentials":{"$ref":"#/definitions/PspCheckoutCredentials","title":"Checkout credentials"}},"type":"object"} accountDisplayName: TestAccountDisplayName workspaces: - 7f9f1882-a103-408d-ac96-46a7021e537a - 70025496-f2a8-4211-b852-32261cbd8cde notificationUrl: >- https://yourcompany-api-pub.staging.payrails.io/public/notification/provider/testpsp/accountName/TestPSP workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: action - event: ruleEngineExecuted time: '2022-02-03T14:34:43.557Z' details: action: determinePaymentOptions context: meta: order: reference: '******' customer: reference: '******' clientContext: ipAddress: '******' rulesets: - id: 670e7a35-c282-469f-b77f-336b75bcbe55 version: 1 createdAt: '2022-11-02T12:27:22.73972022Z' trigger: 'on': determinePaymentOptions filter: paymentMethodCode: card workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a rules: - condition: left: field: customer.country.code operator: IS ONE OF value: - AR - CL operator: AND right: field: clientContext.osType operator: '=' value: ios action: type: setPriority params: priority: 1 - condition: field: clientContext.osType operator: '=' value: web action: type: setPriority params: priority: 2 defaultAction: type: skip evaluations: - chosenRule: condition: left: field: customer.country.code operator: IS ONE OF value: - AR - CL operator: AND right: field: clientContext.osType operator: '=' value: ios action: type: setPriority params: priority: 1 action: type: setPriority params: priority: 1 ruleEvaluationResults: - rule: condition: left: field: customer.country.code operator: IS ONE OF value: - AR - CL operator: AND right: field: clientContext.osType operator: '=' value: ios action: type: setPriority params: priority: 1 result: true - rule: condition: field: clientContext.osType operator: '=' value: web action: type: setPriority params: priority: 2 result: false entity: paymentMethodCode: card integrationType: api description: Card. paymentInstruments: - id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 holderId: 788c7c09-a490-4603-915a-e2a957a6cca1 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' paymentMethod: card displayName: Visa **** 1111 description: Personal card. merchantReference: ref_C47C47 fingerprint: 739abff0-406a-4d32-8cfb-701e12be5848 status: created futureUsage: CardOnFile networkTransactionReference: '987654321234567' data: network: visa bin: '411111' suffix: '1111' expiryMonth: '10' expiryYear: '2026' holderName: John Doe billingAddress: country: code: DE name: Germany postalCode: '10117' workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: action - event: executionActionRequested time: '2022-02-03T14:34:42.557Z' details: action: authorize actionId: 9fce7f2c-faac-4b10-8a24-c146687f9e97 request: amount: value: '12.50' currency: EUR returnInfo: success: https://mysuccessurl.com error: https://myerrorurl.com pending: https://mypendingurl.com paymentComposition: - paymentInstrumentId: 384279fe-fee4-441d-9836-d2ef663551ad paymentMethodCode: card integrationType: api amount: value: '12.50' currency: EUR meta: customer: reference: '******' response: name: authorize actionId: 1aa0ef20-36cb-4485-b60e-0526c3699014 executedAt: '2022-04-22T17:53:36.814Z' links: execution: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016 consumerWait: >- https://api.staging.payrails.io/public/redirect/merchant/example-merchant/100ade99-ef8d-43de-8a35-4d31dbdb37d0/99e2f33a-2d17-4c98-8242-6bf5a4a08016/dGVtcG9yYXJ5LWF1dGgK capture: method: POST href: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/capture cancel: method: POST href: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/cancel workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: api - event: executionActionRequested time: '2022-02-03T14:34:41.557Z' details: action: authorize actionId: 54c05fd4-c054-4b59-a829-4eb76f33f4ea request: amount: value: '12.50' currency: EUR returnInfo: success: https://mysuccessurl.com error: https://myerrorurl.com pending: https://mypendingurl.com paymentComposition: - paymentInstrumentId: 384279fe-fee4-441d-9836-d2ef663551ad paymentMethodCode: card integrationType: api amount: value: '12.50' currency: EUR meta: customer: reference: '******' response: errors: - id: a24bc325-3929-4d9d-9c08-b3aa532685b7 code: Service Not Available detail: >- The requested operation is unavailable at the moment. workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: api - event: executionCreated time: '2022-02-03T14:34:39.557Z' details: request: merchantReference: order_3573894940903 holderReference: customer_836361394 meta: order: reference: '******' customer: reference: '******' clientContext: ipAddress: '******' initialActions: - action: lookup method: POST body: amount: value: '12.50' currency: EUR meta: customer: reference: '******' clientContext: ipAddress: '******' response: id: 5d0e7a85-c982-499f-bb7f-296b75bcbe10 status: - code: created time: '2022-02-03T14:38:41.557Z' createdAt: '2022-02-03T14:38:40.557Z' merchantReference: order_3573894940903 holderId: 9d113e2a-35a0-40e1-828b-35a18ac35b41 holderReference: customer123 workflow: version: 3 code: payment-acceptance meta: order: reference: '******' customer: reference: '******' clientContext: ipAddress: '******' links: self: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016 lookup: method: POST href: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/lookup initialResults: - httpCode: 200 body: name: lookup actionId: 1aa0ef20-36cb-4485-b60e-0526c3699014 executedAt: '2022-02-03T14:38:40.557Z' data: paymentCompositionOptions: - paymentMethodCode: card integrationType: api description: Card. paymentInstruments: - id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 holderId: 788c7c09-a490-4603-915a-e2a957a6cca1 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' paymentMethod: card displayName: Visa **** 1111 description: Personal card. merchantReference: ref_C47C47 fingerprint: 739abff0-406a-4d32-8cfb-701e12be5848 status: created futureUsage: CardOnFile networkTransactionReference: '987654321234567' data: network: visa bin: '411111' suffix: '1111' expiryMonth: '10' expiryYear: '2026' holderName: John Doe billingAddress: country: code: DE name: Germany postalCode: '10117' links: execution: href: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016 authorize: method: POST href: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/authorize startPaymentSession: method: POST href: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/startPaymentSession workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: api - event: executionActionRequested time: '2022-02-03T14:34:42.557Z' details: action: lookup request: amount: value: '12.50' currency: EUR meta: customer: reference: '******' clientContext: ipAddress: '******' response: name: lookup actionId: 1aa0ef20-36cb-4485-b60e-0526c3699014 executedAt: '2022-02-03T14:38:40.557Z' data: paymentCompositionOptions: - paymentMethodCode: card integrationType: api description: Card. paymentInstruments: - id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 holderId: 788c7c09-a490-4603-915a-e2a957a6cca1 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' paymentMethod: card displayName: Visa **** 1111 description: Personal card. merchantReference: ref_C47C47 fingerprint: 739abff0-406a-4d32-8cfb-701e12be5848 status: created futureUsage: CardOnFile networkTransactionReference: '987654321234567' data: network: visa bin: '411111' suffix: '1111' expiryMonth: '10' expiryYear: '2026' holderName: John Doe billingAddress: country: code: DE name: Germany postalCode: '10117' clientConfig: displayName: Card supportsSaveInstrument: true flow: direct - paymentMethodCode: bankAccount integrationType: api description: Bank Account. paymentInstruments: - id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 holderId: 788c7c09-a490-4603-915a-e2a957a6cca1 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' paymentMethod: bankAccount description: Personal bank account. merchantReference: ref_C47C47 fingerprint: 739abff0-406a-4d32-8cfb-701e12be5848 status: created data: holder: firstName: John lastName: Doe companyName: ABC Corp address: streetName: Example St streetNumber: '123' postalCode: '12345' city: Anytown stateOrProvince: CA country: US email: john.doe@example.com dob: '1990-01-15' country: code: US name: United States city: New York type: personal bank: name: Example Bank branchCode: '1234' code: '56789' address: streetName: Bank St streetNumber: '5' postalCode: '98765' city: Banktown stateOrProvince: NY country: US swiftCode: EXABUS33XXX country: code: US name: United States account: number: '1234567890' iban: US123456789012345678901234567890 currency: USD type: savings clientConfig: displayName: Bank Account supportsSaveInstrument: true flow: direct instrumentDataSchema: id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 holderId: 788c7c09-a490-4603-915a-e2a957a6cca1 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' paymentMethod: bankAccount description: Personal bank account. merchantReference: ref_C47C47 fingerprint: 739abff0-406a-4d32-8cfb-701e12be5848 status: created data: holder: firstName: John lastName: Doe companyName: ABC Corp address: streetName: Example St streetNumber: '123' postalCode: '12345' city: Anytown stateOrProvince: CA country: US email: john.doe@example.com dob: '1990-01-15' country: code: US name: United States city: New York type: personal bank: name: Example Bank branchCode: '1234' code: '56789' address: streetName: Bank St streetNumber: '5' postalCode: '98765' city: Banktown stateOrProvince: NY country: US swiftCode: EXABUS33XXX country: code: US name: United States account: number: '1234567890' iban: US123456789012345678901234567890 currency: USD type: savings links: execution: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016 authorize: method: POST href: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016/authorize workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: api - event: ruleEngineExecuted time: '2022-02-03T14:34:43.557Z' details: action: determinePaymentOptions context: meta: order: reference: '******' customer: reference: '******' clientContext: ipAddress: '******' rulesets: - id: 670e7a35-c282-469f-b77f-336b75bcbe55 version: 1 createdAt: '2022-11-02T12:27:22.73972022Z' trigger: 'on': determinePaymentOptions filter: paymentMethodCode: card workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a rules: - condition: left: field: customer.country.code operator: IS ONE OF value: - AR - CL operator: AND right: field: clientContext.osType operator: '=' value: ios action: type: setPriority params: priority: 1 - condition: field: clientContext.osType operator: '=' value: web action: type: setPriority params: priority: 2 defaultAction: type: skip evaluations: - chosenRule: condition: left: field: customer.country.code operator: IS ONE OF value: - AR - CL operator: AND right: field: clientContext.osType operator: '=' value: ios action: type: setPriority params: priority: 1 action: type: setPriority params: priority: 1 ruleEvaluationResults: - rule: condition: left: field: customer.country.code operator: IS ONE OF value: - AR - CL operator: AND right: field: clientContext.osType operator: '=' value: ios action: type: setPriority params: priority: 1 result: true - rule: condition: field: clientContext.osType operator: '=' value: web action: type: setPriority params: priority: 2 result: false entity: paymentMethodCode: card integrationType: api description: Card. paymentInstruments: - id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 holderId: 788c7c09-a490-4603-915a-e2a957a6cca1 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' paymentMethod: card displayName: Visa **** 1111 description: Personal card. merchantReference: ref_C47C47 fingerprint: 739abff0-406a-4d32-8cfb-701e12be5848 status: created futureUsage: CardOnFile networkTransactionReference: '987654321234567' data: network: visa bin: '411111' suffix: '1111' expiryMonth: '10' expiryYear: '2026' holderName: John Doe billingAddress: country: code: DE name: Germany postalCode: '10117' workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: action - notificationEvent: id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 workflowCode: payment-acceptance workflowExecutionId: 8a780068-bf6b-4ba1-9b24-d32606b2fc19 workflowExecutionEventId: 42dc198e-fee0-45e9-aaa6-765036a15ade workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a createdAt: '2022-02-03T14:38:40.557Z' updatedAt: '2022-02-03T14:38:40.557Z' status: delivered body: >- {"action":"authorize","actionId":"71f9cfed-1583-4483-b5d8-49af91749d85","amount":{"currency":"EUR","value":"22.50"},"execution":{"id":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","holderId":"fe8397fc-3301-4ffa-b0bc-b7f83e835a64","holderReference":"84c51416-e06c-4dff-a76f-72fd66f3182d","merchantReference":"679b48ed-ae78-48ae-b19a-460b52c2354d"}} event: networkOffersEnrollmentCompleted time: '2022-04-22T17:53:36.814Z' details: actionId: 1aa0ef20-36cb-4485-b60e-0526c3699014 execution: workflowCode: d5454c2f-ae5e-44f3-8edf-f6dad64f005f id: c5454c2f-ae5e-44f3-8edf-e6dad64f006f merchantReference: order_3573894940903 holderReference: customer123 meta: order: reference: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios success: true paymentComposition: - integrationType: api paymentMethodCode: card success: true operationResult: Success operationProviderReference: provider-reference-example providerId: 5eb08656-ecce-4c3c-9a8a-61d484172322 providerConfigId: 5eb08656-ecce-4c3c-9a8a-61d484172322 paymentInstrumentId: a3a7e52d-bdcc-46a3-a9f2-702b5d7925b0 storeInstrument: true paymentInstrument: id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 holderId: 788c7c09-a490-4603-915a-e2a957a6cca1 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' paymentMethod: card displayName: Visa **** 1111 description: Personal card. merchantReference: ref_C47C47 fingerprint: 739abff0-406a-4d32-8cfb-701e12be5848 status: created futureUsage: CardOnFile networkTransactionReference: '987654321234567' data: network: visa bin: '411111' suffix: '1111' expiryMonth: '10' expiryYear: '2026' holderName: John Doe billingAddress: country: code: DE name: Germany postalCode: '10117' tokens: - type: networkOffers reference: network-offers-token meta: holderReference: network-offers-customer-reference workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: api - notificationEvent: id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 workflowCode: payment-acceptance workflowExecutionId: 8a780068-bf6b-4ba1-9b24-d32606b2fc19 workflowExecutionEventId: 42dc198e-fee0-45e9-aaa6-765036a15ade workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a createdAt: '2022-02-03T14:38:40.557Z' updatedAt: '2022-02-03T14:38:40.557Z' status: delivered body: >- {"action":"authorize","actionId":"71f9cfed-1583-4483-b5d8-49af91749d85","amount":{"currency":"EUR","value":"22.50"},"execution":{"id":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","holderId":"fe8397fc-3301-4ffa-b0bc-b7f83e835a64","holderReference":"84c51416-e06c-4dff-a76f-72fd66f3182d","merchantReference":"679b48ed-ae78-48ae-b19a-460b52c2354d"}} event: executionActionUpdated time: '2022-04-22T17:53:36.814Z' details: action: authorize actionId: 1aa0ef20-36cb-4485-b60e-0526c3699014 execution: workflowCode: d5454c2f-ae5e-44f3-8edf-f6dad64f005f id: c5454c2f-ae5e-44f3-8edf-e6dad64f006f merchantReference: order_3573894940903 holderReference: customer123 meta: order: reference: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios success: true amount: value: '12.50' currency: EUR paymentComposition: - operationType: Authorize amount: currency: EUR value: '24.00' integrationType: api operationResult: Success operationProviderReference: provider-reference-example providerId: 5eb08624-ecce-4cbc-9a8a-61d484172815 provider: id: 5eb08624-ecce-4cbc-9a8a-61d484172815 name: checkout displayName: Checkout.com type: Payment status: active configSchema: >- {"required":["accountDetails","credentials"],"definitions":{"PspCheckoutAccountDetails":{"required":["processingChannelId"],"properties":{"processingChannelId":{"title":"Processing channel ID","minLength":1,"pattern":"^pc_.+$","type":"string"}},"type":"object"},"PspCheckoutCredentials":{"required":["clientId","clientSecret"],"properties":{"clientId":{"title":"Client ID","description":"Client ID used to authenticate requests to the Checkout API","minLength":1,"type":"string"},"clientSecret":{"title":"Client Secret","description":"Client Secret used to authenticate requests to the Checkout API","minLength":1,"type":"string","format":"secret"},"hmacKeys":{"title":"HMAC keys","description":"HMAC keys used to authenticate notifications from the Checkout API","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","items":{"type":"string"},"type":"array","format":"secret"}},"type":"object"}},"properties":{"accountDetails":{"$ref":"#/definitions/PspCheckoutAccountDetails","title":"Account details"},"credentials":{"$ref":"#/definitions/PspCheckoutCredentials","title":"Checkout credentials"}},"type":"object"} createdAt: '2021-01-05T10:20:00.000Z' updatedAt: '2022-06-14T11:50:00.000Z' providerConfigId: a0ad4cd3-f243-4f1a-b294-f7c3df701b10 paymentId: c9e1a8ea-a0de-42bd-bcfd-46d3f437b5fe paymentInstrumentId: a4a7ed2d-bdcc-46a3-a9f2-701b5d7924b0 storeInstrument: true paymentMethodCode: card accountFundingTransaction: true authorizationCode: X055258 acquirerReference: '1233524535345' providerReference: '1027724325777' retrievalReference: '8657867867867' acquirerAccountCode: MI21 acquirerCountryCode: NL acquirerMID: 50TP avsResultCode: 'Y' cvvResultCode: M success: true workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a paymentInstrument: tokens: - type: psp reference: provider-token meta: holderReference: provider-customer-reference id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 holderId: 788c7c09-a490-4603-915a-e2a957a6cca1 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' paymentMethod: card displayName: Visa **** 1111 description: Personal card. merchantReference: ref_C47C47 fingerprint: 739abff0-406a-4d32-8cfb-701e12be5848 status: created futureUsage: CardOnFile networkTransactionReference: '987654321234567' data: network: visa bin: '416598' binLookup: bin: '416598' network: visa localNetwork: bancontact issuer: Revolut issuerCountry: code: LT name: Lithuania iso3: LTU segment: infinite type: debit typeDetails: personal suffix: '1111' expiryMonth: '10' expiryYear: '2026' holderName: John Doe billingAddress: country: code: DE name: Germany postalCode: '10117' captureMode: Instant workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: api - notificationEvent: id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 workflowCode: payment-acceptance workflowExecutionId: 8a780068-bf6b-4ba1-9b24-d32606b2fc19 workflowExecutionEventId: 42dc198e-fee0-45e9-aaa6-765036a15ade workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a createdAt: '2022-02-03T14:38:40.557Z' updatedAt: '2022-02-03T14:38:40.557Z' status: delivered body: >- {"action":"authorize","actionId":"71f9cfed-1583-4483-b5d8-49af91749d85","amount":{"currency":"EUR","value":"22.50"},"execution":{"id":"8a780068-bf6b-4ba1-9b24-d32606b2fc19","holderId":"fe8397fc-3301-4ffa-b0bc-b7f83e835a64","holderReference":"84c51416-e06c-4dff-a76f-72fd66f3182d","merchantReference":"679b48ed-ae78-48ae-b19a-460b52c2354d"}} event: executionActionPending time: '2022-04-22T17:53:36.814Z' details: action: authorize actionId: 1aa0ef20-36cb-4485-b60e-0526c3699014 execution: workflowCode: d5454c2f-ae5e-44f3-8edf-f6dad64f005f id: c5454c2f-ae5e-44f3-8edf-e6dad64f006f merchantReference: order_3573894940903 holderReference: customer123 requiredAction: type: redirect subType: client href: https://api.sandbox.checkout.com method: GET meta: order: reference: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios amount: value: '12.50' currency: EUR paymentComposition: - amount: currency: EUR value: '24.00' integrationType: api operationType: Authorize operationResult: Pending operationProviderReference: provider-reference-example providerId: 5eb08624-ecce-4cbc-9a8a-61d484172815 provider: id: 5eb08624-ecce-4cbc-9a8a-61d484172815 name: checkout displayName: Checkout.com type: Payment status: active configSchema: >- {"required":["accountDetails","credentials"],"definitions":{"PspCheckoutAccountDetails":{"required":["processingChannelId"],"properties":{"processingChannelId":{"title":"Processing channel ID","minLength":1,"pattern":"^pc_.+$","type":"string"}},"type":"object"},"PspCheckoutCredentials":{"required":["clientId","clientSecret"],"properties":{"clientId":{"title":"Client ID","description":"Client ID used to authenticate requests to the Checkout API","minLength":1,"type":"string"},"clientSecret":{"title":"Client Secret","description":"Client Secret used to authenticate requests to the Checkout API","minLength":1,"type":"string","format":"secret"},"hmacKeys":{"title":"HMAC keys","description":"HMAC keys used to authenticate notifications from the Checkout API","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","items":{"type":"string"},"type":"array","format":"secret"}},"type":"object"}},"properties":{"accountDetails":{"$ref":"#/definitions/PspCheckoutAccountDetails","title":"Account details"},"credentials":{"$ref":"#/definitions/PspCheckoutCredentials","title":"Checkout credentials"}},"type":"object"} createdAt: '2021-01-05T10:20:00.000Z' updatedAt: '2022-06-14T11:50:00.000Z' providerConfigId: a0ad4cd3-f243-4f1a-b294-f7c3df701b10 paymentId: c9e1a8ea-a0de-42bd-bcfd-46d3f437b5fe paymentInstrumentId: a4a7ed2d-bdcc-46a3-a9f2-701b5d7924b0 storeInstrument: true paymentMethodCode: card providerReference: '1027724325777' workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a success: true paymentInstrument: id: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 holderId: 788c7c09-a490-4603-915a-e2a957a6cca1 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' paymentMethod: card displayName: Visa **** 1111 description: Personal card. merchantReference: ref_C47C47 fingerprint: 739abff0-406a-4d32-8cfb-701e12be5848 status: created futureUsage: CardOnFile networkTransactionReference: '987654321234567' data: network: visa bin: '416598' binLookup: bin: '416598' network: visa localNetwork: bancontact issuer: Revolut issuerCountry: code: LT name: Lithuania iso3: LTU segment: infinite type: debit typeDetails: personal suffix: '1111' expiryMonth: '10' expiryYear: '2026' holderName: John Doe billingAddress: country: code: DE name: Germany postalCode: '10117' workspaceId: 0bd0f200-fcff-4f63-8b16-0f692d62bd2f eventTrigger: api '401': 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. 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 '403': description: Insufficient Scope. content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object description: >- Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure). required: - id - code - detail properties: id: type: string format: uuid description: >- Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. 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 '404': 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. 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 '429': 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. 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). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. 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`. 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 security: - BearerToken: - executions:read components: securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: > You can use your secret API key in the `x-api-key` header of your API requests for supported endpoints: `x-api-key: `. API keys are environment specific and should be securely guarded. You don't have your API key yet? Contact your Payrails account manager. 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 `. These tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint. ```` ## Related topics - [Receive notifications](/docs/orchestration/payment-acceptance/receive-notifications.md) - [Search & list API Logs](/reference/apilogs.md) - [Search & list actions](/reference/listactions.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.