> ## 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. # Get an instrument by ID > Get instrument by ID. ## OpenAPI ````yaml https://cdn.payrails.io/docs/api/openapi.min.json get /payment/instruments/{instrumentId} 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: /payment/instruments/{instrumentId}: get: tags: - Instruments summary: Get an instrument by ID description: Get instrument by ID. operationId: getInstrument parameters: - name: instrumentId in: path description: Identifier of the resource in Payrails. required: true schema: type: string format: uuid example: d5454c2f-ae5e-44f3-8edf-f6dad64f005f - name: includeTokens in: query schema: type: boolean default: false description: Boolean indicating if token list should be included in the response. - name: includeHolderReference in: query schema: type: boolean default: false description: >- Boolean indicating if the holder reference should be included in the response. responses: '200': description: Success. content: application/json: schema: 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: - 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: 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 examples: card: description: Card instrument. value: 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' cardWithTokens: description: Card instrument with tokens. value: 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: - id: 5671c2cc-32c4-437d-a830-c449db87c542 createdAt: '2022-04-22T17:53:36.814Z' updatedAt: '2022-04-22T17:53:36.814Z' instrumentId: b8fe6271-5d71-4d28-b8e8-89e64acc0c49 status: created type: network providerId: e0ba44eb-1d54-4317-823b-d2f9419d3b9d providerConfigId: 69e0aac4-2939-427e-aa37-d79e4989219c reference: token-in-the-provider meta: securityCodeExpireAt: '2023-08-06T09:16:10.011778Z' cardWithBinLookup: description: Card instrument with BIN lookup. value: 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' applePay: description: ApplePay instrument. value: 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: applePay displayName: MasterCard 0049 description: ApplePay merchantReference: ref_C47C47 status: created networkTransactionReference: '987654321234567' data: network: mastercard binLookup: issuerCountry: code: DE network: mastercard segment: Mastercard Standard type: CREDIT expiryMonth: '10' expiryYear: '2026' networkDisplayName: Mastercard billingAddress: country: code: DE name: Germany postalCode: '10117' suffix: '1111' paymentToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... googlePay: description: GooglePay instrument. value: 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: googlePay displayName: Mastercard •••• 1001 description: GooglePay merchantReference: ref_C47C47 status: created networkTransactionReference: '987654321234567' data: network: mastercard binLookup: network: mastercard issuerCountry: code: DE segment: Mastercard Standard expiryMonth: '10' expiryYear: '2026' suffix: '1111' networkDisplayName: Mastercard billingAddress: country: code: DE postalCode: '10117' paymentToken: '{"signature":"MEUCIQCjP8Zv1M0Vzc02uwVuOhAOIfdr7...' payPal: description: PayPal instrument. value: 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: payPal displayName: john.doe@payrails.com description: PayPal status: created data: billingAddress: country: code: DE email: john.doe@payrails.com payerId: PKP9FD994XXX '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: - instruments: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 - [Get payment by ID](/reference/getpayment.md) - [Get Dispute by ID](/reference/getdispute.md) - [Get record and aliases for a given instrumentId.](/reference/recordsforinstrument.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.