> ## 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. # Create an execution > Create a workflow execution. ## OpenAPI ````yaml https://cdn.payrails.io/docs/api/openapi.min.json post /merchant/workflows/{workflowCode}/executions 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: post: tags: - Executions summary: Create an execution description: Create a workflow execution. operationId: createExecution 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: x-idempotency-key in: header description: > Idempotency key to be used. Sending again the same key would return the same result without re-executing the update. required: true schema: type: string format: uuid example: 91874e4d-81e9-4486-aee4-ee1de84da890 requestBody: content: application/json: schema: anyOf: - title: Payment. type: object 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 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: Payout. type: object required: - merchantReference - holderId 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: Payrails holder reference that is KYC approved. workspaceId: type: string description: >- References in which workspace the execution will be created. workflowVersion: type: integer description: Version of a Workflow Configuration. 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. examples: WithInitialActionLookup: description: With initial action 'lookup'. value: initialActions: - action: lookup method: POST body: amount: value: '12.50' currency: EUR meta: customer: reference: customer123 country: code: DE clientContext: osType: ios language: de_DE merchantReference: order_3573894940903 holderReference: '1231905323475' meta: order: reference: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios origin: https://example.com risk: allowNative3DS: false Default: description: Without initial actions. value: merchantReference: order_3573894940903 holderReference: '1231905323475' meta: order: reference: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios origin: https://example.com risk: allowNative3DS: false WithInitialActionStartPaymentSession: description: With initial action 'startPaymentSession'. value: initialActions: - action: startPaymentSession method: POST body: integrationType: api amount: value: '12.50' currency: EUR returnInfo: success: https://mysuccessurl.com merchantReference: order_3573894940903 holderReference: '1231905323475' meta: order: reference: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios origin: https://example.com risk: allowNative3DS: false WithInitialActionAuthorizePayment: description: With initial action 'authorize'. value: initialActions: - action: authorize method: POST body: 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 installments: count: 2 planReference: INS54434-2 totalAmount: 12.9 requires: - threeDSecure merchantReference: order_3573894940903 holderReference: '1231905323475' meta: order: reference: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios origin: https://example.com risk: allowNative3DS: false responses: '201': description: Created. content: application/json: schema: anyOf: - title: Payment type: object 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 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: - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} preferredScheme: type: string description: Network of the instrument. enum: - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} 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: - {} properties: bin: {} 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: {} 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: {} lastName: {} companyName: {} address: {} email: {} dob: {} country: {} city: {} type: {} bank: type: object description: >- The data structure for a bank's information. properties: name: {} branchCode: {} code: {} address: {} swiftCode: {} account: type: object description: >- The data structure for an account's information. properties: number: {} iban: {} currency: {} country: {} type: {} - 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: {} doorNumber: {} complement: {} area: {} city: {} postalCode: {} state: {} country: {} latitude: {} longitude: {} phone: {} alias: {} name: {} lastName: {} email: {} - title: GooglePay type: object description: Data specific to a GooglePay instrument. allOf: - type: object required: - {} - {} properties: network: {} networkDisplayName: {} binLookup: {} billingAddress: {} shippingAddress: {} suffix: {} expiryMonth: {} expiryYear: {} paymentToken: {} eci: {} cardHolderAuthenticated: {} - type: object properties: googleMessageId: {} googleMessageExpirationId: {} - title: ApplePay type: object description: Data specific to a ApplePay instrument. 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. - 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: - {} properties: code: {} iso3: {} name: {} 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: {} number: {} - 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: {} description: {} example: {} value: type: {} description: {} example: {} 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 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: Payout type: object properties: 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`. examples: Default: description: Without initial actions. value: 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: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a 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 WithInitialActionLookup: description: With initial action 'lookup'. value: 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 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: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a 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 WithInitialActionStartPaymentSession: description: With initial action 'startPaymentSession'. value: initialResults: - httpCode: 200 body: name: startPaymentSession actionId: 1aa0ef20-36cb-4485-b60e-0526c3699014 executedAt: '2022-02-03T14:38:40.557Z' data: id: 100ade99-ef8d-43de-8a35-4d31dbdb37d0 data: Ab02b4c... links: execution: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016 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: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a 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 WithInitialActionLookupAndStartPaymentSession: description: With initial actions 'lookup' and 'startPaymentSession'. value: 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 - httpCode: 200 body: name: startPaymentSession actionId: 1aa0ef20-36cb-4485-b60e-0526c3699014 executedAt: '2022-02-03T14:38:40.557Z' data: id: 100ade99-ef8d-43de-8a35-4d31dbdb37d0 data: Ab02b4c... links: execution: >- https://api.staging.payrails.io/merchant/workflows/100ade99-ef8d-43de-8a35-4d31dbdb37d0/executions/99e2f33a-2d17-4c98-8242-6bf5a4a08016 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: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a 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 WithInitialActionAuthorize: description: With initial action 'authorize'. value: initialResults: - httpCode: 200 body: 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 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: order_3573894940903 customer: reference: '1231905323475' country: code: DE clientContext: ipAddress: 217.110.239.132 osType: ios workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a 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 '400': description: Bad Request. content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object description: >- Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure). required: - id - code - detail properties: id: type: string format: uuid description: >- Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster. 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.malformed detail: The request has malformed syntax docUrl: >- https://docs.payrails.com/docs/resources/error-codes#requestmalformed '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:create 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 - [Create a workflow execution](/docs/orchestration/payment-acceptance/create-a-workflow-execution.md) - [Workspaces](/docs/account-setup/workspaces.md) - [Apple Pay](/docs/orchestration/payment-methods/apple-pay.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.