Flow

Create a new payin within Flow workflows (entity-level)

Creates a new payin transaction within a Flow workflow context. The payin includes invoice data, supported assets, fallback settlement addresses, and generates a payment link for customer interaction.

post/entities/{entityDID}/flow/payins

Request

Base URL
https://api.eu1.notabene.id
Auth
HTTP bearer
TypeScript
https://skmtc.dev/notabene/apis/notabene-api/docs/entities/:entityDID/flow/payins/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

Request body

refstring required

Client-provided reference (e.g., invoice number)

currencystring required

Currency code for the transaction

amountstring required

Transaction amount

supportedAssetsstring[] required

List of supported assets for this transaction (CAIP-19, USD, EUR)

fallbackSettlementAddressesstring[] required

List of fallback settlement addresses (CAIP-10 or payto://)

memostring

Optional transaction memo

Response

Payin created successfully

Changes

No recorded changes to this operation across all 1 revision of this API.