Private API Reference

Real-Time Payments Transfer Prefunded Position Quota

A Real-Time Payments Transfer Prefunded Position Quota is a quota of funds that can be used for Real-Time Payments Transfers outside of wire hours.

The Real-Time Payments Transfer Prefunded Position Quota object

{
  "current_wire_window_closes_at": "2020-01-31T23:59:59Z",
  "next_wire_window_opens_at": "2020-01-31T23:59:59Z",
  "total_amount": 100000000,
  "type": "real_time_payments_transfer_prefunded_position_quota",
  "used_amount": 50000000
}

Attributes

current_wire_window_closes_at

string

Nullable

The ISO 8601 date and time at which the current wire window closes. null if outside of wire hours.

next_wire_window_opens_at

string

The ISO 8601 date and time at which the next wire window opens.

total_amount

integer

The total amount of the quota in USD cents.

type

string

A constant representing the object’s type. For this resource it will always be real_time_payments_transfer_prefunded_position_quota.

used_amount

integer

The amount of the quota that has been used in USD cents.

Retrieve a Real-Time Payments Transfer Prefunded Position Quota for a Bank

curl \
  --url "${INCREASE_URL}/real_time_payments_transfer_prefunded_position_quotas/first_internet_bank" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

bank

string

Required

The bank to retrieve the prefunded position quota for.

Between 1 and 200 characters