Structure a payment intent
compile_intentTurn a corporate FX or payment requirement into a PaymentIntent: the currencies, the amount and whether it is what leaves or what must land, the value date, and the principal's own constraints. Accepts a sentence ('pay a Japanese supplier JPY 800m by 15 October') with the source currency, a flat form, or a full intent. The source currency is never assumed. Returns the intent, its hash and every assumption made. Free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | ISO 4217 code it must land in. | |
| from | No | ISO 4217 code the money leaves in. | |
| text | No | The requirement in plain words. | |
| payer | No | Who is paying, so onboarding_status can be resolved per candidate instead of defaulting to onboardable-with-steps. All optional. | |
| amount | No | The amount. | |
| value_date | No | ISO date the money must land by. | |
| amount_basis | No | Whether the amount leaves (source) or must land (destination). Default destination. | |
| max_all_in_bps | No | The principal's own limit on all-in cost against the reference, in basis points. | |
| max_settlement_days | No | The principal's own limit on settlement time. | |
| allowed_rail_classes | No | Optional. Only these rail classes may carry the payment: bank, specialist_fx, payout_network, payment_network, local_rail, stablecoin. Default: all. |