Interfaces

note

PayString was previously known as PayID.

See also: PayString API Reference.

The PayString protocol includes the following interface definitions.

PaymentInformation type

interface PaymentInformation {

addresses: Address[]

payId?: string

memo?: string

}

AddressDetailsType

enum AddressDetailsType {

CryptoAddress = 'CryptoAddressDetails'

FiatAddress = 'FiatAddressDetails'

}

CryptoAddressDetails

interface CryptoAddressDetails {

address: string

tag?: string

}

FiatAddressDetails

interface FiatAddressDetails {

accountNumber: string

routingNumber?: string

}

Address

interface Address {

paymentNetwork: string

environment?: string

addressDetailsType: AddressDetailsType

addressDetails: CryptoAddressDetails | FiatAddressDetails

}