Example Requests

These are sample payloads that can be used when creating an expected payment.

Expecting to be charged

The following request will indicate that you are expecting to be charged $10.

{
  "direction": "debit",
  "amount_lower_bound": 1000,
  "amount_upper_bound": 1000,
  "internal_account_id": "<Internal Account ID>"
}

Expecting to receive money

The following request will indicate that you're expecting to receive $200,000

{
  "direction": "credit",
  "amount_lower_bound": 20000000,
  "amount_upper_bound": 20000000,
  "internal_account_id": "<Internal Account ID>"
}

Using Ranges

The following request uses ranges to show that you're expecting to receive between $100-$110, somewhere on the dates 1/28/2019-1/30/2019. If a transaction doesn't match these criteria, it wouldn't be reconciled to the expected payment

{
  "direction": "credit",
  "amount_lower_bound": 10000,
  "amount_upper_bound": 11000,
  "internal_account_id": "<Internal Account ID>",
  "date_lower_bound": "2019-01-28",
  "date_upper_bound": "2019-01-29"
}

Using counterparties

You may attach counterparty information to help us match the expected payment to transactions. This may be helpful. Often in bank transfers, your counterparty's name and/or bank details will be attached.

You may use either details from an existing counterparty or new information not attached to any counterparty. If you provide both, we will use the existing counterparty's data

{
  "direction": "credit",
  "amount_lower_bound": 20000000,
  "amount_upper_bound": 20000000,
  "internal_account_id": "<Internal Account ID>",
  "counterparty_id": "a009f8e7-11f4-43f7-b46d-024b951cf930"
}
{
  "direction": "credit",
  "amount_lower_bound": 20000000,
  "amount_upper_bound": 20000000,
  "internal_account_id": "<Internal Account ID>",
  "counterparty_name": "James Potter",
  "counterparty_bank_routing_number": "021000021"
}