T-0 Network

https://docs.t-0.network/docs
Admin
T-0 Network is a payment network platform that enables quote management, payment flows, provider...
Tokens:18,918
Snippets:129
Trust Score:4.8
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install NodeJS Provider SDK

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/ts-sdk

Installs the t-0 Provider SDK using npm. Ensure you have NodeJS v20 or later installed.

```bash
npm i @t-0/provider-sdk
```

--------------------------------

### Golang Provider Handler Setup

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/go-sdk

Initializes the t-0 Network provider handler with the network's public key and the service implementation. Optional configurations like signature verification and Connect handler options can be provided.

```go
// t-0 Network hex formatted public key
networkPublicKey := "0x049bb924680bfba3f64d924bf9040c45dcc215b124b5b9ee73ca8e32c050d042c0bbd8dbb98e3929ed5bc2967f28c3a3b72dd5e24312404598bbf6c6cc47708dc7"

providerServiceHandler, err := provider.NewProviderHandler(
    provider.NetworkPublicKeyHexed(networkPublicKey), // t-0 Network public key
    &ProviderServiceImplementation{}, // This is your service implementation - replace with your actual implementation
    // optional configuration
    provider.WithVerifySignatureFn(verifySignatureFn) // Custom signature verification function
    provider.WithConnectHandlerOptions(HandlerOptions) // Additional Connect handler options
)
if err != nil {
    log.Fatalf("Failed to create provider service handler: %v", err)
}
```

--------------------------------

### Golang Network Client Service Operation Example

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/go-sdk

Demonstrates how to perform a network service operation, such as updating a quote, using the initialized t-0 Network client. Includes basic error handling for the request.

```go
// Example: Update quote operation
_, err = networkClient.UpdateQuote(context.Background(), connect.NewRequest(&networkproto.UpdateQuoteRequest{
    // Request parameters
}))
if err != nil {
    log.Printf("Failed to update quote: %v", err)
    return
}
```

--------------------------------

### Golang HTTP Server Start with Provider Handler

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/go-sdk

Launches an HTTP server using the provider service handler. This is an optional step and can be integrated with existing HTTP server implementations. Configuration options for address, timeouts, and TLS are available.

```go
shutdownFunc := provider.StartServer( // Start the HTTP server with the provider service handler, one-liner, you can also use your own HTTP server implementation 
    providerServiceHandler,
    // optional configuration
    provider.WithAddr(":8080"),
    provider.WithReadTimeout(10 * time.Second)
    provider.WithWriteTimeout(10 * time.Second)
    provider.WithReadHeaderTimeout(10 * time.Second)
    provider.WithTLSConfig(tlsConfig)
)

// Manual shutdown handling
if err := shutdownFunc(context.Background()); err != nil {
    log.Printf("Failed to shutdown server: %v", err)
}
```

--------------------------------

### Golang HTTP Server Creation without Starting

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/go-sdk

Creates an HTTP server instance configured with the provider service handler without immediately starting it. This allows for further customization before the server is run.

```go
server := provider.NewServer(
    providerServiceHandler,
    provider.WithAddr(":8080"),
)
```

--------------------------------

### Perform Network Quote Update Operation (TypeScript)

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/ts-sdk

Example of updating a quote using the t-0 Network client. This involves creating `Decimal` types for rates and amounts, specifying currency, expiration, and quote type. Requires `@t-0/provider-sdk`.

```typescript
const updateResponse = await networkClient.updateQuote({
  payIn: [{
    bands: [{
      rate: toProtoDecimal(123, -2), // meaning decimal number 1.23
      maxAmount: toProtoDecimal(1000, 0), // Maximum amount in $1000 USD equivalent
      clientQuoteId: randomUUID(),
    }],
    currency: 'EUR', // Example currency
    expiration: timestampFromDate(new Date(Date.now() + 60 * 1000)), // Example expiration time (1 minute from now)
    quoteType: QuoteType.REALTIME, // Example quote type
    timestamp: timestampNow(), // Current timestamp
  }]
})

```

--------------------------------

### Manually Generate secp256k1 Key Pair using OpenSSL

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/introduction

This set of commands manually generates secp256k1 private and public key pairs using OpenSSL. It first generates a private key into a PEM file, then extracts the private key in hexadecimal format, and finally extracts the public key in hexadecimal format. Requires OpenSSL to be installed.

```bash
# Generate private key
 openssl ecparam -genkey -name secp256k1 -noout > private_key.pem

# Extract private key hex
 openssl ec -in private_key.pem -text -noout 2>/dev/null | grep -A 3 'priv:' | tail -n +2 | tr -d '\n: ' | sed 's/[^0-9a-f]//g'

# Extract public key hex
 openssl ec -in private_key.pem -text -noout 2>/dev/null | grep -A 5 'pub:' | tail -n +2 | tr -d '\n: ' | sed 's/[^0-9a-f]//g'
```

--------------------------------

### Protocol Implementation Approach

Source: https://docs.t-0.network/docs/integration-guidance/introduction

Describes the direct protocol implementation for maximum control, requiring manual management of client-side, server-side, and cryptographic operations.

```APIDOC
## Protocol Implementation Approach

### Description
For maximum control, providers can implement the Connect RPC protocol directly. This approach requires manual management of client-side and server-side aspects, including cryptographic operations.

### Method
N/A (Manual Implementation)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A

#### Success Response (200)
None

#### Response Example
None

**Requirements:**
- Implement client-side and server-side Connect RPC protocol.
- Manually manage cryptographic operations.
- Generate client and server stubs from provided protocol buffer definitions (`network.proto`, `provider.proto`).
- Implement appropriate retry logic and circuit breaker patterns.
```

--------------------------------

### Configure and Serve HTTP Provider Service (TypeScript)

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/ts-sdk

Sets up an HTTP server to register and serve a provider service using the t-0 SDK. It includes signature validation and uses `nodeAdapter` for request handling. Requires `@t-0/provider-sdk`.

```typescript
import createService, {signatureValidation} from "@t-0/provider-sdk";
import * as http from "http";
import { nodeAdapter } from "@t-0/provider-sdk";

const server = http.createServer(
  signatureValidation(
    nodeAdapter(
      createService(networkPublicKeyHex, CreateProviderService())))
).listen(8080);
console.log("server is listening at", server.address());

```

--------------------------------

### SDK Integration Approach

Source: https://docs.t-0.network/docs/integration-guidance/introduction

Details the streamlined integration path using the T-0 Network SDK, abstracting complexity and handling cryptographic operations.

```APIDOC
## SDK Integration Approach

### Description
The T-0 Network SDK offers a simplified integration path for payment providers, handling protocol implementation and cryptographic operations. It currently supports Go and manages request signing, signature verification, and key management.

### Method
N/A (SDK Usage)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A

#### Success Response (200)
None

#### Response Example
None

**Features:**
- Abstracts protocol complexity.
- Handles cryptographic operations (signing, verification, key management).
- Provides built-in error handling, retry logic, and connection management.
- Providers implement callback handlers for network-initiated operations.
```

--------------------------------

### Initialize t-0 Network Client (TypeScript)

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/ts-sdk

Initializes the t-0 Network client for direct interaction with network services. Requires a private key and the network endpoint. The client handles authentication and request signing automatically. Uses `@t-0/provider-sdk`.

```typescript
import createNetworkClient from "@t-0/provider-sdk";

const privateKeyHex = "0x7795db2f4499c04d80062c1f1614ff1e427c148e47ed23e387d62829f437b5d8";
const endpoint = "https://sandbox-api.t-0.network";
const networkClient = createNetworkClient(privateKeyHex, endpoint);

```

--------------------------------

### Navigation Links

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/payment-network

Navigation links for Introduction Guidance and Payment Provider.

```APIDOC
## Navigation Links

### Description
Provides navigation links for Introduction Guidance and Payment Provider.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

### Request Body
- None

### Request Example
None

### Response
#### Success Response (200)
- **_navigate_before_** (string) - Link to "Introduction Guidance".
- **_navigate_next_** (string) - Link to "Payment Provider".

#### Response Example
```json
{
  "_navigate_before_": "/guidance/introduction",
  "_navigate_next_": "/providers/payment"
}
```
```

--------------------------------

### gRPC Protocol Implementation

Source: https://docs.t-0.network/docs/integration-guidance/introduction

Details the gRPC implementation for high-performance, strongly-typed communication, emphasizing efficiency and tooling support.

```APIDOC
## gRPC Protocol Implementation

### Description
Utilizes gRPC for high-performance, strongly-typed communication with a binary protocol encoding for efficiency. This approach is suitable for high-volume processing and integrates well with microservices architectures.

### Method
N/A (gRPC Usage)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A

#### Success Response (200)
None

#### Response Example
None

**Key Aspects:**
- **Protocol:** gRPC with binary encoding.
- **Interfaces:** `NetworkService` (client-side calls) and `ProviderService` (server-side implementation).
- **Generated Stubs:** From `network.proto` and `provider.proto`.
- **Considerations:** Connection management, long-lived connections, streaming operations, retry logic, circuit breakers.
```

--------------------------------

### Golang Network Client Initialization

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/go-sdk

Initializes the t-0 Network client using a private key. The client handles authentication and request signing automatically for direct interaction with t-0 Network services.

```go
import (
    "context"
    "log"

    "connectrpc.com/connect"
    networkproto "github.com/t-0-network/provider-sdk-go/api/gen/proto/network"
    "github.com/t-0-network/provider-sdk-go/pkg/network"
)

// Initialize with private key
yourPrivateKey := network.PrivateKeyHexed("0x7795db2f4499c04d80062c1f1614ff1e427c148e47ed23e387d62829f437b5d8")

networkClient, err := network.NewServiceClient(yourPrivateKey)
if err != nil {
    log.Fatalf("Failed to create network service client: %v", err)
}
```

--------------------------------

### ProviderService - UpdateLimit

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/payment-provider

This rpc is used to notify the provider about the changes in credit limit and/or credit usage.

```APIDOC
## POST /ProviderService/UpdateLimit

### Description
This rpc is used to notify the provider about the changes in credit limit and/or credit usage.

### Method
POST

### Endpoint
/ProviderService/UpdateLimit

### Parameters
#### Request Body
- **participant_id** (uint32) - Required - The ID of the participant whose limit is being updated.
- **credit_limit** (tzero.v1.common.Decimal) - Optional - The new credit limit.
- **credit_usage** (tzero.v1.common.Decimal) - Optional - The updated credit usage.

### Request Example
```json
{
  "participant_id": 101,
  "credit_limit": {
    "value": "5000.00",
    "exponent": 2
  },
  "credit_usage": {
    "value": "1500.75",
    "exponent": 2
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Credit limit and usage updated successfully."
}
```
```

--------------------------------

### Generate secp256k1 Key Pair using Makefile

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/introduction

This command utilizes the provided Makefile to automatically generate secp256k1 private and public key pairs. Ensure the Makefile is present in your project directory. The output will display the generated private and public keys in hexadecimal format.

```bash
make keygen
```

--------------------------------

### Implement Provider Service Interface (TypeScript)

Source: https://docs.t-0.network/docs/integration-guidance/sdk-integration/ts-sdk

Defines a provider service by implementing the `ProviderService` interface. This service handles various t-0 Network requests such as payouts, payment updates, and ledger entries. It requires the `@t-0/provider-sdk` package.

```typescript
import {
  PayoutRequest,
  PayoutResponse,
  UpdatePaymentRequest,
  UpdatePaymentResponse,
  CreatePayInDetailsRequest,
  CreatePayInDetailsResponse,
  UpdateLimitRequest,
  UpdateLimitResponse,
  AppendLedgerEntriesRequest,
  AppendLedgerEntriesResponse,
} from "@t-0/provider-sdk";
import {HandlerContext} from "@t-0/provider-sdk";


const CreateProviderService = () => {
  return {
    async payOut(req: PayoutRequest, context: HandlerContext) {
      return {} as PayoutResponse
    },

    async updatePayment(req: UpdatePaymentRequest, context: HandlerContext) {
      return {} as UpdatePaymentResponse
    },

    async createPayInDetails(req: CreatePayInDetailsRequest, context: HandlerContext) {
      return {} as CreatePayInDetailsResponse
    },

    async updateLimit(req: UpdateLimitRequest, context: HandlerContext) {
      return {} as UpdateLimitResponse
    },

    async appendLedgerEntries(req: AppendLedgerEntriesRequest, context: HandlerContext) {
      return {
      } as AppendLedgerEntriesResponse
    },
  }
};

```

--------------------------------

### CreatePayment API

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/payment-network

Submits a request to create a new payment. Optionally specify pay-in currency and quote ID.

```APIDOC
## POST /CreatePayment

### Description
Submit a request to create a new payment. PayIn currency and QuoteId are the optional parameters. If the payIn currency is not specified, the network will use USD as the default payIn currency, and considering the amount in USD. If specified, it must be a valid currency code - in this case the network will try to find the payIn quote for the specified currency and considering the band from the provider initiated this request. So this is only possible, if this provider already submitted the payIn quote for the specified currency using UpdateQuote rpc. If the quoteID is specified, it must be a valid quoteId that was previously returned by the GetPayoutQuote method. If the quoteId is not specified, the network will try to find a suitable quote for the payout currency and amount, same way as GetPayoutQuote rpc.

### Method
POST

### Endpoint
/CreatePayment

### Parameters
#### Request Body
- **request** (CreatePaymentRequest) - Required - The request object containing payment details.

### Request Example
```json
{
  "request": {
    "paymentClientId": "payment-123",
    "amount": {
      "currency": "EUR",
      "value": "900"
    },
    "payIn": {
      "currency": "USD",
      "paymentMethod": "BANK_TRANSFER"
    },
    "payOut": {
      "currency": "EUR",
      "paymentMethod": "SEPA"
    },
    "travelRuleData": {
      "originator": [],
      "beneficiary": []
    }
  }
}
```

### Response
#### Success Response (200)
- **response** (CreatePaymentResponse) - Details of the created payment, including success or failure status.

#### Response Example
```json
{
  "response": {
    "paymentClientId": "payment-123",
    "success": {
      "paymentId": "p789",
      "payoutId": "po101"
    }
  }
}
```
```

--------------------------------

### UpdateQuote RPC Method

Source: https://docs.t-0.network/docs/network/quote-management

Providers use the UpdateQuote RPC method to publish quotes for pay-in and payout operations. These quotes define exchange rates and capacity bands used for routing payments and calculating optimal pricing.

```APIDOC
## POST /update-quote

### Description
Publishes or updates a quote for payment routing. Quotes define exchange rates and capacity bands for pay-in and payout operations.

### Method
POST

### Endpoint
/update-quote

### Parameters
#### Request Body
- **client_quote_id** (string) - Required - An identifier for the provider to track their own quotes.
- **quote_currency** (string) - Required - The provider's local currency for the quote (e.g., EUR, GBP).
- **base_currency** (string) - Required - The base currency for the quote, which is always USD.
- **rate** (number) - Required - The exchange rate from the base currency (USD) to the quote currency.
- **max_amount** (number) - Required - The maximum USD amount for which the rate applies within a specific pricing band.
- **bands** (array) - Required - A list of pricing bands, each with a `rate` and `max_amount`.
- **is_payout** (boolean) - Required - True if the quote is for a payout operation, false for pay-in.
- **expiration_timestamp** (string) - Required - The timestamp indicating when the quote becomes invalid (ISO 8601 format).

### Request Example
```json
{
  "client_quote_id": "provider-quote-12345",
  "quote_currency": "EUR",
  "base_currency": "USD",
  "rate": 0.92,
  "max_amount": 1000,
  "bands": [
    { "rate": 0.92, "max_amount": 1000 },
    { "rate": 0.91, "max_amount": 5000 },
    { "rate": 0.90, "max_amount": 10000 },
    { "rate": 0.89, "max_amount": 25000 }
  ],
  "is_payout": false,
  "expiration_timestamp": "2024-07-27T10:00:00Z"
}
```

### Response
#### Success Response (200)
- **quote_id** (string) - A unique identifier for the published quote.
- **status** (string) - The status of the quote (e.g., "published", "updated").

#### Response Example
```json
{
  "quote_id": "net-quote-abcde",
  "status": "published"
}
```
```

--------------------------------

### Request Authentication Headers

Source: https://docs.t-0.network/docs/integration-guidance/protocol/authentication

Details on the required HTTP headers for authenticating network requests.

```APIDOC
## Request Authentication

All network communications require cryptographic authentication using ECDSA signatures with Keccak-256 hashing.

### Required Headers

- **X-Signature** (string) - Required - The hex-encoded ECDSA signature of the request body, suffixed with the current Unix timestamp in milliseconds.
- **X-Public-Key** (string) - Required - The hex-encoded public key corresponding to the private key used for signing. Accepts compressed (33 bytes) or uncompressed (65 bytes) formats.
- **X-Signature-Timestamp** (integer) - Required - The Unix timestamp in milliseconds used as the suffix during signature generation. Must be within one minute of the current server time.

### Signing Process Overview

1. Obtain the current Unix timestamp in milliseconds (64-bit unsigned integer, little-endian).
2. Append the timestamp to the request body.
3. Hash the combined data using Keccak-256.
4. Sign the resulting hash using the provider's ECDSA private key.
5. The final signature is provided in the `X-Signature` header, and the timestamp in the `X-Signature-Timestamp` header.

### Signature Verification Overview

1. Extract the timestamp from the `X-Signature-Timestamp` header.
2. Append the timestamp to the request body.
3. Hash the combined data with Keccak-256.
4. Verify the signature against the network's known public key using the hashed data.
```

--------------------------------

### ProviderService API

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/payment-intent-provider

Services implemented by the provider to offer pay-in details for payment intents.

```APIDOC
## POST /websites/t-0_network/ProviderService/CreatePaymentIntent

### Description
Network instructs the provider to create payment details for the payment intent. The provider should return a list of supported payment methods along with a URL where the payer should be redirected.

### Method
POST

### Endpoint
/websites/t-0_network/ProviderService/CreatePaymentIntent

### Parameters
#### Request Body
- **payment_intent_id** (uint64) - Required - Idempotency key.
- **currency** (string) - Required - The pay-in currency.
- **amount** (tzero.v1.common.Decimal) - Required - The pay-in amount.
- **merchant_id** (uint32) - Required - The merchant identifier.

### Request Example
```json
{
  "payment_intent_id": 123456789,
  "currency": "USD",
  "amount": "100.00",
  "merchant_id": 101
}
```

### Response
#### Success Response (200)
- **payment_methods** (CreatePaymentIntentResponse.PaymentMethod) - repeated - A list of supported payment methods.

#### Response Example
```json
{
  "payment_methods": [
    {
      "payment_url": "https://pay.example.com/intent/123456789",
      "payment_method": "credit_card"
    }
  ]
}
```

## POST /websites/t-0_network/ProviderService/ConfirmPayout

### Description
Network notifies the provider about a successful payout for the corresponding payment intent.

### Method
POST

### Endpoint
/websites/t-0_network/ProviderService/ConfirmPayout

### Parameters
#### Request Body
- **payment_intent_id** (uint64) - Required - payment_intent_id from CreatePaymentIntentRequest.
- **payment_id** (uint64) - Required - The corresponding payment_id for this payment intent.

### Request Example
```json
{
  "payment_intent_id": 123456789,
  "payment_id": 987654321
}
```

### Response
#### Success Response (200)
This message has no fields defined.

#### Response Example
```json
{}
```
```

--------------------------------

### NetworkService - Payment Intent API

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/payment-intent-recipient

Provides endpoints for managing payment intents, including creation and obtaining quotes.

```APIDOC
## POST /websites/t-0_network/NetworkService/CreatePaymentIntent

### Description
Creates a new payment intent. This is the first step in processing a payment.

### Method
POST

### Endpoint
/websites/t-0_network/NetworkService/CreatePaymentIntent

### Parameters
#### Request Body
- **payment_reference** (string) - Required - Idempotency Key payment reference to identify payment by client.
- **pay_in_currency** (string) - Required - Pay-in currency
- **pay_in_amount** (tzero.v1.common.Decimal) - Required - Amount denominated in the pay-in currency
- **pay_out_currency** (string) - Required - Payout currency
- **pay_out_method** (tzero.v1.common.PaymentMethod) - Required - Payout payment method

### Request Example
```json
{
  "payment_reference": "ref123",
  "pay_in_currency": "USD",
  "pay_in_amount": {
    "value": "100.00"
  },
  "pay_out_currency": "EUR",
  "pay_out_method": {
    "type": "BANK_TRANSFER"
  }
}
```

### Response
#### Success Response (200)
- **payment_intent_id** (uint64) - Description of the payment intent ID.
- **pay_in_payment_methods** (CreatePaymentIntentResponse.PaymentMethod) - repeated - Available payment methods for pay-in.

#### Response Example
```json
{
  "payment_intent_id": 1234567890,
  "pay_in_payment_methods": [
    {
      "payment_url": "https://example.com/pay/xyz",
      "provider_id": 1,
      "payment_method": {
        "type": "CARD"
      }
    }
  ]
}
```
```

```APIDOC
## POST /websites/t-0_network/NetworkService/GetQuote

### Description
Retrieves a quote for a potential payment, including the exchange rate and expiration time.

### Method
POST

### Endpoint
/websites/t-0_network/NetworkService/GetQuote

### Parameters
#### Request Body
- **pay_in_currency** (string) - Required - Pay-in currency
- **pay_in_amount** (tzero.v1.common.Decimal) - Required - Amount denominated in the pay-in currency
- **pay_out_currency** (string) - Required - Payout currency
- **pay_in_payment_method** (tzero.v1.common.PaymentMethodType) - Required - Payment method to use for the pay-in.
- **pay_out_payment_method** (tzero.v1.common.PaymentMethodType) - Required - Payment method to use for the pay-out.

### Request Example
```json
{
  "pay_in_currency": "USD",
  "pay_in_amount": {
    "value": "100.00"
  },
  "pay_out_currency": "EUR",
  "pay_in_payment_method": "BANK_TRANSFER",
  "pay_out_payment_method": "BANK_TRANSFER"
}
```

### Response
#### Success Response (200)
- **quote** (GetQuoteResponse.Quote) - Details about the quote, including rate and expiration.
- **not_found** (GetQuoteResponse.NotFound) - Indicates if the quote could not be found.

#### Response Example
```json
{
  "quote": {
    "rate": {
      "value": "0.92"
    },
    "expiration": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### UpdateQuote API

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/payment-network

Publishes pay-in and pay-out quotes (FX rates) into the network. Quotes include tiered pricing bands and an expiration timestamp.

```APIDOC
## POST /UpdateQuote

### Description
Used by the provider to publish pay-in and pay-out quotes (FX rates) into the network. These quotes include tiered pricing bands and an expiration timestamp.

### Method
POST

### Endpoint
/UpdateQuote

### Parameters
#### Request Body
- **request** (UpdateQuoteRequest) - Required - The request object containing quote details.

### Request Example
```json
{
  "request": {
    "payInCurrencies": [
      {
        "currency": "USD",
        "quotes": [
          {
            "quoteId": "q123",
            "amount": {
              "currency": "USD",
              "value": "1000"
            },
            "expirationTimestamp": "2024-12-31T23:59:59Z",
            "fxRate": "1.0"
          }
        ]
      }
    ],
    "payoutCurrencies": [
      {
        "currency": "EUR",
        "quotes": [
          {
            "quoteId": "q456",
            "amount": {
              "currency": "EUR",
              "value": "900"
            },
            "expirationTimestamp": "2024-12-31T23:59:59Z",
            "fxRate": "0.9"
          }
        ]
      }
    ]
  }
}
```

### Response
#### Success Response (200)
- **response** (UpdateQuoteResponse) - Details of the quote update operation.

#### Response Example
```json
{
  "response": {
    "success": true
  }
}
```
```

--------------------------------

### ProviderService - PayOut

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/payment-provider

Network instructs the provider to execute a payout to the recipient. This method should be idempotent, meaning that multiple calls with the same parameters will have no additional effect.

```APIDOC
## POST /ProviderService/PayOut

### Description
Network instructs the provider to execute a payout to the recipient. This method should be idempotent, meaning that multiple calls with the same parameters will have no additional effect.

### Method
POST

### Endpoint
/ProviderService/PayOut

### Parameters
#### Request Body
- **payment_id** (uint64) - Required - Payment ID assigned by the network.
- **payout_id** (uint64) - Required - Payout ID assigned by the network.
- **currency** (string) - Required - Currency of the payout.
- **client_quote_id** (string) - Required - Client quote ID of the quote used for this payout.
- **amount** (tzero.v1.common.Decimal) - Required - Amount in the specified currency.
- **payout_method** (tzero.v1.common.PaymentMethod) - Optional - Payment method for the payout.
- **pay_in_provider_id** (uint32) - Optional - Pay-in provider ID which initiated the payout.
- **travel_rule_data** (PayoutRequest.TravelRuleData) - Optional - Travel rule data for the payout.

### Request Example
```json
{
  "payment_id": 12345,
  "payout_id": 67890,
  "currency": "USD",
  "client_quote_id": "quote_abc123",
  "amount": {
    "value": "100.50",
    "exponent": 2
  },
  "payout_method": {
    "type": "BANK_TRANSFER",
    "details": {
      "account_number": "123456789",
      "routing_number": "987654321"
    }
  },
  "travel_rule_data": {
    "sender_name": "John Doe",
    "sender_address": "123 Main St"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the payout.

#### Response Example
```json
{
  "status": "SUCCESS"
}
```
```

--------------------------------

### GetQuote API

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/payment-network

Requests the best available quote for a payout in a specific currency and amount. Prior quotes should be updated using UpdateQuote.

```APIDOC
## POST /GetQuote

### Description
Request the best available quote for a payout in a specific currency, for a given amount. If the payout quote exists, but the credit limit is exceeded, this quote will not be considered. Before calling this endpoint UpdateQuote should be periodically triggered in order to put pay-in quotes into the network.

### Method
POST

### Endpoint
/GetQuote

### Parameters
#### Request Body
- **request** (GetQuoteRequest) - Required - The request object containing payout currency and amount.

### Request Example
```json
{
  "request": {
    "payoutCurrency": "EUR",
    "amount": {
      "currency": "EUR",
      "value": "900"
    }
  }
}
```

### Response
#### Success Response (200)
- **response** (GetQuoteResponse) - The best available quote for the requested payout.

#### Response Example
```json
{
  "response": {
    "quote": {
      "quoteId": "q456",
      "amount": {
        "currency": "EUR",
        "value": "900"
      },
      "expirationTimestamp": "2024-12-31T23:59:59Z",
      "fxRate": "0.9"
    }
  }
}
```
```

--------------------------------

### Address Structure

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/travel-rule

Defines the structure for an address, including various components like street, city, country, and address lines. It enforces constraints for validity.

```APIDOC
## Address Structure

### Description
Represents a postal address. Requires at least one of `addressLine` or a combination of `streetName`, `buildingName`, and/or `buildingNumber`.

### Fields

- **address_type** (AddressTypeCode) - Definition: Identifies the nature of the address.
- **department** (string) - Definition: Identification of a division of a large organisation or building.
- **sub_department** (string) - Definition: Identification of a sub-division of a large organisation or building.
- **street_name** (string) - Definition: Name of a street or thoroughfare.
- **building_number** (string) - Definition: Number that identifies the position of a building on a street.
- **building_name** (string) - Definition: Name of the building or house.
- **floor** (string) - Definition: Floor or storey within a building.
- **post_box** (string) - Definition: Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.
- **room** (string) - Definition: Building room number.
- **post_code** (string) - Definition: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
- **town_name** (string) - Definition: Name of a built-up area, with defined boundaries and a local government.
- **town_location_name** (string) - Definition: Specific location name within the town.
- **district_name** (string) - Definition: Identifies a subdivision within a country subdivision.
- **country_sub_division** (string) - Definition: Identifies a subdivision of a country for example, state, region, province, départment or county.
- **address_line** (string, repeated) - Definition: Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
- **country** (string) - Constraint: The value used for the field country must be present on the ISO-3166-1 alpha-2 codes or the value XX. - Definition: The country associated with the address.
```

--------------------------------

### ProviderService - UpdatePayment

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/payment-provider

Network provides an update on the status of a payment. This can be either a success or a failure. This method should be idempotent.

```APIDOC
## POST /ProviderService/UpdatePayment

### Description
Network provides an update on the status of a payment. This can be either a success or a failure. This method should be idempotent, meaning that multiple calls with the same parameters will have no additional effect.

### Method
POST

### Endpoint
/ProviderService/UpdatePayment

### Parameters
#### Request Body
- **payment_id** (uint64) - Required - The ID of the payment to update.
- **status** (string) - Required - The new status of the payment (e.g., "SUCCESS", "FAILED").
- **failure_reason** (string) - Optional - Reason for payment failure, if applicable.

### Request Example
```json
{
  "payment_id": 12345,
  "status": "SUCCESS"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Payment status updated successfully."
}
```
```

--------------------------------

### Date and Place of Birth Structure

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/travel-rule

Defines the structure for recording a person's date and place of birth. Includes a constraint to ensure the date is in the past.

```APIDOC
## DateAndPlaceOfBirth Structure

### Description
Represents the date and place of birth of an individual.

### Constraint
- **DateInPast**: If `dateOfBirth` is specified, the date specified must be a historic date (i.e., a date prior to the current date).

### Fields

- **date_of_birth** (string) - Format: YYYY-MM-DD - Definition: Date on which a person is born. A point in time, represented as a day within the calendar year. Compliant with ISO 8601.
- **place_of_birth** (string) - Definition: The town and/or the city and/or the suburb and/or the country subdivision and/or the country where the person was born.
```

--------------------------------

### Idempotency and Request Safety

Source: https://docs.t-0.network/docs/integration-guidance/introduction

Explains the idempotency levels for RPC methods to ensure safe retries and prevent duplicate processing.

```APIDOC
## Idempotency and Request Safety

### Description
All network RPC methods specify idempotency levels to ensure safe retry behavior and prevent duplicate processing. Methods marked as IDEMPOTENT can be safely retried multiple times with the same parameters without causing additional side effects. Methods marked as NO_SIDE_EFFECTS, such as GetPayoutQuote, can be called multiple times without any system state changes.

### Method
N/A (Conceptual)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A

#### Success Response (200)
None

#### Response Example
None

**Key Concepts:**
- **IDEMPOTENT:** Safe to retry multiple times with the same parameters.
- **NO_SIDE_EFFECTS:** Safe to call multiple times without changing system state (e.g., GetPayoutQuote).
```

--------------------------------

### ProviderService - AppendLedgerEntries

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/payment-provider

Network can send all the updates about ledger entries of the provider’s accounts. It can be used to keep track of the provider’s exposure to other participants and other important financial events.

```APIDOC
## POST /ProviderService/AppendLedgerEntries

### Description
Network can send all the updates about ledger entries of the provider’s accounts. It can be used to keep track of the provider’s exposure to other participants and other important financial events.

### Method
POST

### Endpoint
/ProviderService/AppendLedgerEntries

### Parameters
#### Request Body
- **transactions** (array of AppendLedgerEntriesRequest.Transaction) - Required - A list of transactions appended to the provider's ledger.

### Request Body - AppendLedgerEntriesRequest.Transaction
- **transaction_id** (uint64) - Required - Unique identifier for the transaction.
- **entries** (array of AppendLedgerEntriesRequest.LedgerEntry) - Required - List of ledger entries.
- **payout** (AppendLedgerEntriesRequest.Transaction.Payout) - Optional - Payout details.
- **provider_settlement** (AppendLedgerEntriesRequest.Transaction.ProviderSettlement) - Optional - Provider settlement details.
- **fee_settlement** (AppendLedgerEntriesRequest.Transaction.FeeSettlement) - Optional - Fee settlement details.

### Request Body - AppendLedgerEntriesRequest.LedgerEntry
- **account_owner_id** (uint32) - Required - ID of the account owner (1 for network, others for participants).
- **account_type** (AppendLedgerEntriesRequest.AccountType) - Required - Type of the account.
- **debit** (tzero.v1.common.Decimal) - Optional - Debit amount.
- **credit** (tzero.v1.common.Decimal) - Optional - Credit amount.

### Request Body - AppendLedgerEntriesRequest.Transaction.FeeSettlement
- **fee_settlement_id** (uint64) - Required - ID of the fee settlement.

### Request Body - AppendLedgerEntriesRequest.Transaction.Payout
- **payment_id** (uint64) - Required - Payment ID associated with the payout.

### Request Body - AppendLedgerEntriesRequest.Transaction.ProviderSettlement
- **settlement_id** (uint64) - Required - ID of the provider settlement.

### Request Example
```json
{
  "transactions": [
    {
      "transaction_id": 1,
      "entries": [
        {
          "account_owner_id": 1,
          "account_type": "ASSET",
          "debit": {
            "value": "100.00",
            "exponent": 2
          }
        },
        {
          "account_owner_id": 101,
          "account_type": "LIABILITY",
          "credit": {
            "value": "100.00",
            "exponent": 2
          }
        }
      ],
      "payout": {
        "payment_id": 12345
      }
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Ledger entries appended successfully."
}
```
```

--------------------------------

### T-0 Network API Endpoints

Source: https://docs.t-0.network/docs/integration-guidance/introduction

Production and sandbox API endpoints for the T-0 Network.

```APIDOC
## T-0 Network API Endpoints

### Description
Provides the base URLs for accessing the T-0 Network API in both production and sandbox environments.

### Method
N/A (Base URLs)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A

#### Success Response (200)
None

#### Response Example
None

**Production:** `https://api.t-0.network`
**Sandbox:** `https://api-sandbox.t-0.network`
```

--------------------------------

### LegalPersonName Structure

Source: https://docs.t-0.network/docs/integration-guidance/api-reference/travel-rule

Details the structure for the name of a legal person, including different types of name identifiers.

```APIDOC
## LegalPersonName Structure

### Description
Represents the name of a legal person.

### Fields

- **name_identifiers** (LegalPersonNameId, repeated) - Definition: The name and type of name by which the legal person is known. Constraint: LegalNamePresent - At least one occurrence of `legalPersonNameIdentifier` must have the value ‘LEGL’ specified in the element `legalPersonNameIdentifierType`.
- **local_name_identifiers** (LocalLegalPersonNameId, repeated) - Definition: The name and type of name by which the legal person is known using local characters.
- **phonetic_name_identifiers** (LocalLegalPersonNameId, repeated) - Definition: The name and type of name by which the legal person is known using local characters.
```
Tokens:
Raw