Add a transfer
add_transferAdd a transfer to the account by its UETR, with the amount, currency and date it was sent. The account's plan decides how it is monitored, as for an add on the website. Adding a UETR the account already holds returns that transfer and uses no more of the plan; an archived one is returned archived. Returns the transfer and the outcome.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uetr | Yes | The transfer's UETR. | |
| amount | Yes | The amount sent and its currency. The currency is a three-letter code in any letter case, one of USD, EUR, GBP, JPY, CHF, CAD, AUD, AED, BDT, BRL, CNY, HKD, IDR, ILS, INR, JOD, MAD, MXN, MYR, NZD, PHP, PKR, PLN, QAR, SAR, SGD, SZL, THB, TRY, TWD, TZS, XAF, XOF, ZAR. The value can have at most 2 decimal places, or none for JPY, XAF and XOF. | |
| payment_date | Yes | The date the payment was sent. It can be no earlier than 2000-01-01 and no later than the next calendar day in UTC. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| free | Yes | ||
| events | Yes | ||
| outcome | Yes | created: a new transfer. existing: the account already held it. archived: the account holds it archived; restore it to resume monitoring. | |
| transfer | Yes | ||
| waiting_at | Yes | In the full view, the bank the payment is waiting at, when the reports name one; otherwise null. | |
| corrections_remaining | Yes |