Correct a transfer's details
update_transferCorrects the amount, currency or payment date entered for a transfer. Bank-reported figures never change. After a bank has reported, the owner can make up to 3 corrections. The owner's corrections on the website count toward the same limit. Give all three details as they should stand; a correction replaces them together, as the website's form does. After a bank has reported, sending the details every copy of this transfer in the account already holds changes nothing and uses no correction; if an older copy holds other details, the save aligns it and counts as one correction. Before a report, every save checks the transfer again. The UETR cannot be changed: it identifies the payment. A correction is refused once the transfer is archived, or when its checks ended before any bank reported on it. Only the account owner's API keys and connected apps can correct details. Returns the transfer, the outcome and the corrections left.
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. A changed date 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 | requeued: no bank had reported yet, so the next check uses the corrected details and no correction was used. corrected: a bank had reported, so the entered details were corrected and one correction was used. unchanged: a bank had reported and every copy of this transfer in the account already held these details, so nothing changed and no correction was used. | |
| 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 |