OpenAPI Document
  1. 4.4 External ID and Metadata
OpenAPI Document
  • 1. Overview
    • 1. Overview
  • 2. Authentication
    • 2.1 Introduction
      • 2.1 Introduction
      • Generating an RSA key pair
    • 2.2 Creating the Bearer Token
      • 2.2 Creating the Bearer Token
      • Creating the token
      • Signature Examples
      • JWT Token Specification
      • Signature Examples
  • 3. Requests & Responses
    • 3.1 Requests
    • 3.2 Responses
    • 3.2 Responses
      • 3.2.1 Succes Responses
      • 3.2.2 Retrying Requests
      • 3.2.3 HTTP Status Codes
      • 3.2.4 Error Responses
        • Error Response Format
  • 4. Getting Started
    • 4.1 Pagination
      • 4.1 Pagination
    • 4.2 Rate Limiting
      • Rate Limits
    • 4.3 Idempotency
      • Idempotency Fields
    • 4.4 External ID and Metadata
      • 4.4 External ID and Metadata
  • 5. API
    • Health
      • 5.1 Test connectivity
      • 5.2 Test connectivity
    • Accounts
      • 5.3 Get Accounts
      • 5.4 Get Accounts
      • 5.5 Get Balances
    • Transfer
      • 5.6 Create a Transfer
    • Transactions
      • 5.7 Get Account Transactions
    • Conversions
      • 5.8 Get a Quote
      • 5.9 Execute a trade
    • Payouts
      • 5.10 Get Payouts
      • 5.11 Create Payout
      • 5.12 Get Payout Quotation
    • Card Account
      • 5.13 Create Card Account
      • 5.14 Get Card Account Transactions
    • Cards
      • 5.15 Issue Card
      • 5.16 Get Cards
      • 5.17 Activate Card
      • 5.18 Suspend Card
      • 5.19 Unsuspend Card
      • 5.20 Lock Card
      • 5.21 Unlock Card
      • 5.22 Cancel a card
      • 5.23 Get Card Senstiive Info
      • 5.24 Change Card PIN
      • 5.25 Control Spending
    • Digital Custody
      • 5.26 Get Supported Digital Assets
      • 5.27 Get Supported Blockchains
      • 5.28 Create Withdrawal Request
      • 5.29 Get Deposit Addresses
      • 5.30 Generate Deposit Address
    • Countries
      • 5.31 Get Countries
    • Positions
      • 5.32 Get Positions
    • Occupations
      • 5.33 Get Occupations
  • 6. Screenshot Illustration（api+image）
    • 6. Screenshot Illustration（api+image）
  1. 4.4 External ID and Metadata

4.4 External ID and Metadata

The xid (external identifier) is an optional identifier that can be attached to resources created through the ORZCash Access API. In most mutation operations that use the POST method, integrations have the ability to attach an xid string and an xmetadata object to the resources they create.
This xid can be used to query and search for resources, and it is included in all webhooks along with xmetadata. Using xid provides added convenience and eliminates the need to implement resource id mapping between ORZCash Access and your own platform.
All endpoints that return customer-managed resources will include the xid and xmetadata fields in the response. It is recommended to use these fields to provide additional context and information about the resources.
xid is visible within the ORZCash platform user interface.
xid is a string and can be up to 256 characters in length.
xmetadata Metadata can be used for attaching arbitrary key-value pairs to resources.
xmetadata is intended to be used for storing additional, structured information on a resource. As an example, you could store your client's SMS or OTP routing information within the xmetadata of each card. If a parent resource and a child resource both contains metadata, the metadata will be merged and returned.
xmetadata fields are visible within the ORZCash platform user interface.
You can specify up to 25 string key-value pairs, with key names up to 40 characters long and values up to 1024 characters long. Attaching nested objects into xmetadata is not supported.
Modified at 2022-12-29 06:33:13
Previous
Idempotency Fields
Next
5.1 Test connectivity
Built with