Skip to main content
POST
Create a transaction intent

Headers

Authorization
string

Bearer authentication header of the form Bearer {token}. Required for client-server (JWT) authentication. See Authentication.

X-Meridian-Program-Id
string

Identifies the program context for the request. Required for server-to-server (HMAC) authentication. See Authentication.

X-Meridian-User-Id
string

Identifies the Meridian user targeted by the request. Required for server-to-server (HMAC) authentication with MULTI_USER integrations; omit for SINGLE_USER. See Authentication.

X-Meridian-Api-Key
string

Partner API key issued by Meridian during provisioning. Required for server-to-server (HMAC) authentication. See Authentication.

X-Meridian-Timestamp
string

Current time in milliseconds since the Unix epoch. Must be within 60 seconds of the request. Required for server-to-server (HMAC) authentication. See Authentication.

X-Meridian-Signature
string

HMAC SHA-256 signature of the canonical request string, computed per request. Required for server-to-server (HMAC) authentication. See Authentication for how to construct it.

Response

The created transaction intent preview

id
string
required
type
enum<string>
required
Available options:
TRANSFER,
DEPOSIT,
WITHDRAWAL,
REFUND,
PARTIAL_REFUND
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
status
enum<string>
required
Available options:
CREATED,
EXPIRED,
CANCELED,
COMMITTED,
FAILED
debitAmount
string
required
debitCurrency
string
required
debitInstrument
Account Instrument · object
required

Meridian (balance) account instrument

creditAmount
string
required
creditCurrency
string
required
creditInstrument
Account Instrument · object
required

Meridian (balance) account instrument

fees
Transaction Fee · object[]
required
exchangeRate
string
required
statusReason
string | null
debitMemo
string | null
purpose
enum<string> | null
Available options:
PAYMENT_FOR_SERVICES,
PAYMENT_FOR_SOFTWARE,
PAYMENT_FOR_IMPORTED_GOODS,
TRAVEL_SERVICES,
VENDOR_CONTRACTOR_PAYOUTS,
TRANSFER_TO_OWN_ACCOUNT,
INVESTMENT_IN_SHARES,
PURCHASE_OF_PROPERTY,
REPAYMENT_OF_LOANS,
SALARY,
PAYMENT_OF_PROPERTY_RENTAL,
INFORMATION_SERVICE_CHARGES,
ADVERTISING_AND_PUBLIC_RELATIONS_EXPENSES,
ROYALTY_TRADEMARK_PATENT_AND_COPYRIGHT_FEES,
BROKER_FRONTEND_GUARANTEE_AND_CUSTODIAN_FEES,
ADVISOR_TECHNICAL_AND_ACADEMIC_FEES,
REPRESENTATIVE_OFFICE_EXPENSES,
TAX_PAYMENT,
TRANSPORTATION_FEES_FOR_GOODS,
CONSTRUCTION_COSTS,
INSURANCE_PREMIUM,
GENERAL_GOODS_TRADES_OFFLINE,
INSURANCE_CLAIMS_PAYMENT,
FAMILY_MAINTENANCE,
EDUCATION_RELATED_EXPENSES,
MEDICAL_TREATMENT,
DONATIONS,
MUTUAL_FUND_INVESTMENT,
CURRENCY_EXCHANGE,
USER_WITHDRAWAL,
ADVANCE_PAYMENTS_FOR_GOODS,
VENDOR_CONTRACTOR_PAYOUTS_SOFTWARE_DEVELOPMENT,
MERCHANT_SETTLEMENT,
REPATRIATION_FUND_SETTLEMENT,
PERSONAL_REMITTANCE,
RETURN_OF_FUNDS