Skip to main content
POST
Simulate Incoming Wire Return Request Acceptance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

wire_id
string
required

ID of the wire whose outgoing return request you want to simulate an acceptance of.

Pattern: ^wire_\w+$

Body

application/json
amount
integer<int64>
required

Amount to be returned, in the currency's minor units. Must be greater than zero and not exceed the original wire amount.

Required range: 1 <= x <= 990000000000
Example:

5000

currency_code
enum<string>
required

A three-letter currency code as defined in ISO 4217.

Available options:
USD
Example:

"USD"

Response

The updated wire object, with the outgoing return request now in accepted status and a return wire credited.

The response is of type object.