v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB

Wallet Accounts

Initiate Last Domestic Leg Payout

Facilitate the real-time settlement of the last domestic leg payout for International Funds Transfer Instructions (IFTI) through NPP rails.

post/wallet_accounts/{id}/npp_last_domestic_leg

Path parameters

idstring required

Wallet account ID

Request body

account_idstring required

Account to withdraw to.

amountinteger required

Amount (in cents) to withdraw.

custom_descriptorstring

A descriptor specified by the customer to be passed on the withdraw call. This requires that custom_descriptors are enabled. In the case of fast payments (AU / NPP) Assembly will append a value in the beginning of descriptor, the customer can use 200 characters (excluding URL, javascript/code, emojis). In the case of DE batch payments will allow 18 characters

reference_idstring

Unique reference information that can be specified for a for wallet withdrawal request. This is an optional field and cannot contain '.' character.

end_to_end_idstring required

A unique identifier assigned by the initiating party to track and reconcile the IFTI payout throughout its lifecycle. This value must be unique per transaction and is included in payment messaging for traceability across participating financial institutions. This is the Debtor’s (customer) reference for the Payment to be provided to Creditor (customer). Mandatory for NPP IFTI Payment.

Example request

{
  "account_id": "c1824ad0-73f1-0138-3700-0a58a9feac09",
  "reference_id": "7190770-1-2908",
  "end_to_end_id": "PRTYAUXXXX",
  "ifti_information": {
    "instruction_identification": "BANKNTSTXXXI20180501000000000000010",
    "ultimate_debtor_information": {
      "name": "John Doe",
      "address": {
        "department": "Finance",
        "sub_department": "Billing",
        "street_name": "Kent",
        "bldg_name": "123",
        "postcode": "2000",
        "town_name": "Sydney",
        "ctry_sub_division": "NSW",
        "country_code": "AU"
      },
      "organisation_identification": [
        {
          "identification_type_code": "BBAN"
        }
      ],
      "organisation_bic": "SMPLAU2SXXX",
      "private_identification": [
        {
          "identification_type_code": "BBAN"
        }
      ],
      "date_place_of_birth": {
        "country_of_birth": "AU"
      },
      "country_of_residence": "AU"
    },
    "charge_bearer": "CRED",
    "previous_instructing_agent": {
      "agent_bic": "YOURBIC1234",
      "clearing_system_identification": "BICCODE123",
      "clearing_system_member_identification": "BICCODE123MEM"
    },
    "creditor_agent_instruction": [
      {
        "instruction_information": "sample",
        "code": "CHQB"
      }
    ],
    "initiating_party_information": {
      "name": "John Doe",
      "address": {
        "department": "Finance",
        "sub_department": "Billing",
        "street_name": "Kent",
        "bldg_name": "123",
        "postcode": "2000",
        "town_name": "Sydney",
        "ctry_sub_division": "NSW",
        "country_code": "AU"
      },
      "organisation_identification": [
        {
          "identification_type_code": "BBAN"
        }
      ],
      "organisation_bic": "SMPLAU2SXXX",
      "private_identification": [
        {
          "identification_type_code": "BBAN"
        }
      ],
      "date_place_of_birth": {
        "country_of_birth": "AU"
      },
      "country_of_residence": "AU"
    },
    "ultimate_creditor_information": {
      "name": "John Doe",
      "address": {
        "department": "Finance",
        "sub_department": "Billing",
        "street_name": "Kent",
        "bldg_name": "123",
        "postcode": "2000",
        "town_name": "Sydney",
        "ctry_sub_division": "NSW",
        "country_code": "AU"
      },
      "organisation_identification": [
        {
          "identification_type_code": "BBAN"
        }
      ],
      "organisation_bic": "SMPLAU2SXXX",
      "private_identification": [
        {
          "identification_type_code": "BBAN"
        }
      ],
      "date_place_of_birth": {
        "country_of_birth": "AU"
      },
      "country_of_residence": "AU"
    },
    "instructed_amount": {
      "currency": "AUD",
      "amount": "3.25"
    },
    "exchange_rate": "1.23",
    "payment_purpose_proprietary": "Prtry",
    "payment_information": {
      "remittance_information_unstructured": "MAP_RE_Happy",
      "payment_purpose_code": "EPAY"
    },
    "regulatory_reporting": [
      {
        "authority_name": "Name"
      }
    ],
    "remittance_information_structured": {
      "referred_document_amount": {
        "due_payable_amount": {
          "currency": "AUD",
          "amount": "3.25"
        }
      }
    },
    "related_remittance_information": [
      {
        "identification": "S010"
      }
    ]
  }
}

Response

Example response

{
  "disbursements": {
    "id": "ad688d54-6791-4f1d-add7-88fbd89b70d1",
    "reference_id": "7190770-1-2908",
    "amount": 10000,
    "currency": "AUD",
    "state": "pending",
    "to": "Bank Account",
    "bank_name": "Bank of Australia",
    "bank_account_name": "Samuel Seller",
    "bank_account_number": "XXX234",
    "bank_routing_number": "XXXXX3",
    "npp_payout_state": "trying",
    "account_name": "My Water Company",
    "biller_name": "ABC Water",
    "crn": "0987654321",
    "links": {
      "transactions": "/disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/transactions",
      "wallet_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/wallet_accounts",
      "paypal_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/paypal_accounts",
      "bank_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/bank_accounts",
      "bpay_accounts": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/bpay_accounts",
      "items": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/items",
      "users": "/disbursements/ea36e48a-4638-4d1a-a345-e1a0a584df8b/users"
    },
    "end_to_end_id": "PRTYAUXXXX",
    "ifti_information": {
      "instruction_identification": "BANKNTSTXXXI20180501000000000000010",
      "ultimate_debtor_information": {
        "name": "John Doe",
        "country_of_residence": "AU",
        "address": {
          "country_code": "AU",
          "address_line": [
            "Level 4",
            "1 Margaret"
          ]
        },
        "organisation_identification": [
          {
            "identification": "ID12345"
          }
        ]
      },
      "charge_bearer": "CRED",
      "previous_instructing_agent": {
        "agent_bic": "YOURBIC1234"
      },
      "creditor_agent_instruction": {
        "instruction_information": "sample",
        "code": "CHQB"
      },
      "initiating_party_information": {
        "name": "John Doe",
        "country_of_residence": "AU",
        "address": {
          "country_code": "AU",
          "address_line": [
            "Level 4",
            "1 Margaret"
          ]
        },
        "organisation_identification": [
          {
            "identification": "ID12345"
          }
        ]
      },
      "instructed_amount": {
        "currency": "AUD",
        "amount": "3.25"
      },
      "ultimate_creditor_information": {
        "name": "John Doe",
        "country_of_residence": "AU",
        "address": {
          "country_code": "AU",
          "address_line": [
            "Level 4",
            "1 Margaret"
          ]
        },
        "organisation_identification": [
          {
            "identification": "ID12345"
          }
        ]
      },
      "exchange_rate": "1.23",
      "payment_purpose_proprietary": "Prtry",
      "payment_information": {
        "remittance_information_unstructured": "MAP_RE_Happy",
        "payment_purpose_code": "EPAY"
      },
      "regulatory_reporting": [
        {
          "authority_name": "Name"
        }
      ],
      "remittance_information_structured": {
        "referred_document_amount": {
          "due_payable_amount": {
            "currency": "AUD",
            "amount": "3.25"
          }
        }
      },
      "related_remittance_information": [
        {
          "identification": "S010"
        }
      ]
    }
  }
}