Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Simulation

Simulate Incoming Instant Payment

Simulate an incoming instant payment.

post/v1/simulate/instant_payments/incoming

Headers

Idempotency-Keystring required

Idempotency key

Request body

creditor_account_number_idstring required

The ID of the Lead Bank Account Number object.

amountinteger required

The amount of the instant payment in cents.

currency_code'USD' required

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

descriptionstring

Free-form information on the reason for the payment.

Example request

{
  "creditor_account_number_id": "account_number_xyz123",
  "amount": 5000,
  "currency_code": "USD",
  "description": "Payment for invoice 12345",
  "debtor": {
    "name": "Alex Smith",
    "account_number": "1234567890"
  },
  "debtor_agent": {
    "routing_number": "111000111"
  },
  "payment_identifiers": {
    "end_to_end_id": "E2E-20240101-001"
  }
}

Response

Intentionally empty - incoming instant payment will be created asynchronously.