Currencytransfer icon

Currencytransfer

Easy and simple currency conversion

Actions19

Payment → Update

AI-generated

Overview

This node updates an existing payment resource in the Currency Transfer system. It allows users to modify details such as the payment amount, reference, beneficiary, and purpose of payment. This is useful in scenarios where payment details need to be corrected or adjusted after creation, for example, updating the payment amount or changing the beneficiary information.

Use Case Examples

  1. Updating the amount of a payment identified by its UUID.
  2. Changing the beneficiary UUID for a specific payment.
  3. Adding or modifying a reference note for the payment order.

Properties

Name Meaning
UUID The unique identifier of the payment resource to be updated.
Trade UUID Identifier of the trade associated with the payment.
Amount The amount of the payment. If set to 0, the payment will be deleted.
Reference A reference string to be added in the payment order by the broker, with restrictions on allowed characters and length.
Beneficiary UUID The UUID of the beneficiary to be paid.
Purpose of Payment The purpose of the payment, which may be required for some partners or countries.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • uuid - The unique identifier of the updated payment resource.
  • tradeUUID - The trade identifier associated with the payment.
  • amount - The updated amount of the payment.
  • reference - The updated reference string for the payment order.
  • beneficiaryUUID - The UUID of the beneficiary to be paid.
  • purpose - The purpose of the payment.
  • status - The current status of the payment after update.

Dependencies

  • An API key credential for authenticating with the Currency Transfer API.

Troubleshooting

  • Ensure the UUID provided is valid and corresponds to an existing payment resource; otherwise, the update will fail.
  • If the amount is set to 0, the payment will be deleted instead of updated, which might be unintended.
  • Check that the reference string adheres to the allowed characters and length restrictions to avoid validation errors.
  • Verify network settings such as proxy and SSL options if requests fail due to connectivity or certificate issues.
  • Timeout errors may occur if the server takes too long to respond; adjust the timeout setting accordingly.

Discussion