API documentation

post/payments

createPayment()

Parameters

Required

Return type

Promise<PaymentTransaction>

Related contracts

export interface CreatePaymentRequest {
  accountId: string;
  provider: PaymentProviderType;
  contactId: string;
  currency: string;
  amount: number;
  reference: string;
  recipientEmail?: string;
  paymentDate?: Date;
  /** Unlimit external SEPA only; omitted elsewhere. Backend defaults to Express when omitted. */
  sepaTransferPriority?: SepaTransferPriority;
}
export interface PaymentTransaction {
  date: string;
  transactionId: string;
  accountId: string;
  direction: PaymentTransactionDirection;
  status: PaymentTransactionStatus;
  from: string;
  to: string;
  reference: string;
  amount: Money;
  amountInBaseCurrency: Money;
  isReturned: boolean;
  accountNumberFrom?: string | null;
  accountNumberTo?: string | null;
}

HTTP mapping

POST /payments

Alipay
Stripe
Eurex
AWS
Azure
Google Cloud
Currenex
Velocity Trade
Bitcoin
CME
Interactive Brokers
Kraken
FIX API
XTX
Bloomberg
Binance

أطلق منصتك.

ابدأ.