PUT web/Wire

Request Information

URI Parameters

None.

Body Parameters

UpdateWire
NameDescriptionTypeAdditional information
beneficiary

UpdateBeneficiary

None.

beneficiarybank

BeneficiaryBank

None.

intermediarybank

IntermediaryBank

None.

furthercreditdetail

FurtherCreditDetail

None.

intermediarybank2

IntermediaryBank2

None.

intermediarybank3

IntermediaryBank3

None.

byorderof

ByOrderOf

None.

additional

Additional

None.

others

Others

None.

wire_metadata

WireMetaData

None.

Request Formats

application/json, text/json

Sample:
{
  "beneficiary": {
    "entity_id": 1,
    "wire_id": 2,
    "internal_reference": "sample string 3",
    "beneficiary_name": "sample string 4",
    "beneficiary_first_name": "sample string 5",
    "beneficiary_last_name": "sample string 6",
    "beneficiary_nickname": "sample string 7",
    "is_non_third_party": true,
    "beneficiary_address1": "sample string 9",
    "beneficiary_address2": "sample string 10",
    "beneficiary_city": "sample string 11",
    "beneficiary_province": "sample string 12",
    "beneficiary_country": {
      "value": "sample string 1",
      "id": 2
    },
    "beneficiary_postcode": "sample string 13",
    "beneficiary_currency": {
      "value": "sample string 1",
      "id": 2
    },
    "beneficiary_accountcode": "sample string 14",
    "beneficiary_accounttype": {
      "value": "sample string 1",
      "id": 2
    },
    "beneficiary_email": "sample string 15",
    "beneficiary_instructions": "sample string 16",
    "type": {
      "value": "sample string 1",
      "id": 2
    },
    "status": {
      "value": "sample string 1",
      "id": 2
    },
    "beneficiary_sendingbank_instructions": "sample string 17",
    "beneficiary_contact_number": "sample string 18",
    "beneficiary_contact_name": "sample string 19",
    "beneficiary_individual_dob": "sample string 20",
    "beneficiary_individual_occupation": "sample string 21",
    "beneficiary_individual_id_type": {
      "value": "sample string 1",
      "id": 2
    },
    "beneficiary_individual_id_number": "sample string 22",
    "beneficiary_account_name": "sample string 23",
    "beneficiary_charge_bearer": {
      "value": "sample string 1",
      "id": 2
    },
    "beneficiary_contact_phone": "sample string 24",
    "beneficiary_is_resident": true,
    "beneficiarybank_branch_name": "sample string 26"
  },
  "beneficiarybank": {
    "beneficiarybank_routingcode": "sample string 1",
    "beneficiarybank_routingcode_id": 2,
    "beneficiarybank_routingtype": {
      "value": "sample string 1",
      "id": 2
    },
    "beneficiarybank_bank_code": "sample string 3",
    "beneficiarybank_name": "sample string 4",
    "beneficiarybank_address1": "sample string 5",
    "beneficiarybank_address2": "sample string 6",
    "beneficiarybank_city": "sample string 7",
    "beneficiarybank_province": "sample string 8",
    "beneficiarybank_country": {
      "value": "sample string 1",
      "id": 2
    },
    "beneficiarybank_postcode": "sample string 9",
    "beneficiarybank_odfi_name": "sample string 10",
    "beneficiarybank_odfi_code": "sample string 11",
    "beneficiarybank_clearing_type": "sample string 12",
    "beneficiarybank_clearing_code": "sample string 13",
    "beneficiarybank_branch_name": "sample string 14"
  },
  "intermediarybank": {
    "interbank1_routingcode": "sample string 1",
    "interbank1_routingcode_id": 2,
    "interbank1_routingtype": {
      "value": "sample string 1",
      "id": 2
    },
    "interbank1_bank_code": "sample string 3",
    "interbank1_name": "sample string 4",
    "interbank1_address1": "sample string 5",
    "interbank1_address2": "sample string 6",
    "interbank1_city": "sample string 7",
    "interbank1_province": "sample string 8",
    "interbank1_country": {
      "value": "sample string 1",
      "id": 2
    },
    "interbank1_postcode": "sample string 9",
    "interbank1_accountno": "sample string 10",
    "interbank1_is_interbank1": true
  },
  "furthercreditdetail": {
    "further_name": "sample string 1",
    "further_is_individual": true,
    "further_isfurther": true,
    "further_address1": "sample string 4",
    "further_address2": "sample string 5",
    "further_city": "sample string 6",
    "further_province": "sample string 7",
    "interbank1_accountno": "sample string 8",
    "further_country": {
      "value": "sample string 1",
      "id": 2
    },
    "further_postcode": "sample string 9",
    "further_accountcode": "sample string 10",
    "further_first_name": "sample string 11",
    "further_last_name": "sample string 12"
  },
  "intermediarybank2": {
    "interbank2_routingcode": "sample string 1",
    "interbank2_routingcode_id": 2,
    "interbank2_routingtype": {
      "value": "sample string 1",
      "id": 2
    },
    "interbank2_bank_code": "sample string 3",
    "interbank2_name": "sample string 4",
    "interbank2_address1": "sample string 5",
    "interbank2_address2": "sample string 6",
    "interbank2_city": "sample string 7",
    "interbank2_province": "sample string 8",
    "interbank2_country": {
      "value": "sample string 1",
      "id": 2
    },
    "interbank2_postcode": "sample string 9",
    "interbank2_accountno": "sample string 10",
    "interbank2_is_interbank2": true
  },
  "intermediarybank3": {
    "interbank3_routingcode": "sample string 1",
    "interbank3_routingcode_id": 2,
    "interbank3_routingtype": {
      "value": "sample string 1",
      "id": 2
    },
    "interbank3_bank_code": "sample string 3",
    "interbank3_name": "sample string 4",
    "interbank3_address1": "sample string 5",
    "interbank3_address2": "sample string 6",
    "interbank3_city": "sample string 7",
    "interbank3_province": "sample string 8",
    "interbank3_country": {
      "value": "sample string 1",
      "id": 2
    },
    "interbank3_postcode": "sample string 9",
    "interbank3_accountno": "sample string 10",
    "interbank3_is_interbank3": true
  },
  "byorderof": {
    "byorderof_isbyorderof": true,
    "byorderof_name": "sample string 2",
    "byorderof_is_individual": true,
    "byorderof_address1": "sample string 4",
    "byorderof_address2": "sample string 5",
    "byorderof_city": "sample string 6",
    "byorderof_province": "sample string 7",
    "byorderof_accountno": "sample string 8",
    "byorderof_country": {
      "value": "sample string 1",
      "id": 2
    },
    "byorderof_postcode": "sample string 9",
    "byorderof_account_type": {
      "value": "sample string 1",
      "id": 2
    },
    "byorderof_id_type": {
      "value": "sample string 1",
      "id": 2
    },
    "byorderof_id_number": "sample string 10",
    "byorderof_id_expiry_date": "sample string 11",
    "byorderof_first_name": "sample string 12",
    "byorderof_last_name": "sample string 13"
  },
  "additional": {
    "is_individual": true,
    "execution_date": "sample string 2",
    "purpose_of_payment_id": {
      "value": "sample string 1",
      "id": 2
    },
    "purpose_of_payment_details": "sample string 3",
    "compliance_status": {
      "value": "sample string 1",
      "id": 2
    }
  },
  "others": {
    "is_other_check": true,
    "other_1": "sample string 2",
    "other_2": "sample string 3",
    "other_3": "sample string 4",
    "other_4": "sample string 5",
    "other_5": "sample string 6",
    "byorderof_account_type": {
      "value": "sample string 1",
      "id": 2
    },
    "byorderof_id_type": {
      "value": "sample string 1",
      "id": 2
    },
    "byorderof_id_number": "sample string 7",
    "byorderof_id_expiry_date": "sample string 8"
  },
  "wire_metadata": {
    "rules": [
      {
        "rule": {
          "value": "sample string 1",
          "id": 2
        },
        "output_value": "sample string 1"
      },
      {
        "rule": {
          "value": "sample string 1",
          "id": 2
        },
        "output_value": "sample string 1"
      }
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateWire'.

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.

Response Information

Resource Description

DSOutput
NameDescriptionTypeAdditional information
status

boolean

None.

data

Object

None.

code

integer

None.

message

string

None.

error

Error

None.

paging

Paging

None.

additional_codes

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": true,
  "data": {},
  "code": 0,
  "message": "sample string 3",
  "error": {
    "code": 0,
    "message": "sample string 1",
    "target": "sample string 2",
    "details": [
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      },
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      }
    ]
  },
  "paging": {
    "page_number": 1,
    "page_size": 2,
    "page_from": 3,
    "page_to": 4,
    "record_count": 5
  },
  "additional_codes": "sample string 4"
}

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.