Return Wire Payment

post

https://api.stage.victorfi.com/v2/payments/wire/return/{victorTransactionId}

Return an inbound wire payment.

Note: When returning an inbound wire to a virtual account if the virtual account has insufficient balance for the return funds will be drawn from the primary account from the ledger automatically to process the return.

Path Params

victorTransactionId

string

required

The reference of the payment transaction.

Body Params

Details of a Wire Return payment.

counterparty_reference

string

required

Victor counterparty reference. Either a counterparty reference or a minimum combination of beneficiary_account, beneficiary_name, beneficiary_street_address1 and receiving_bank_aba is required. If both specified then counterparty reference takes precedence.

reason

string

required

length ≤ 35

additional_information

string

length ≤ 140

amount

string

Optional. Defaults to returning the full amount if not specified. Can't exceed the transaction to return original amount

beneficiary_account

string

length ≤ 34

beneficiary_name

string

length ≤ 35

beneficiary_street_address1

string

length ≤ 35

beneficiary_street_address2

string

length ≤ 35

beneficiary_city

string

City, State and Zip length can't exceed 33 characters in total

beneficiary_state

string

beneficiary_zip

string

beneficiary_reference

string

length ≤ 35

receiving_bank_aba

string

length between 9 and 9

receiving_bank_name

string

length ≤ 18

Headers

Idempotency-Key

string

length ≤ 128

A client provided unique value used by the server to identify subsequent retries of the same request.

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Request succeeded.

400Invalid return payment request.