Skip to main content
POST
/
v1
/
simulate
/
instant_payments
/
incoming
Simulate Incoming Instant Payment
curl --request POST \
  --url https://api.sandbox.lead.bank/v1/simulate/instant_payments/incoming \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "creditor_account_number_id": "account_number_xyz123",
  "amount": 5000,
  "currency_code": "USD",
  "debtor": {
    "name": "Alex Smith",
    "account_number": "1234567890"
  },
  "debtor_agent": {
    "routing_number": "111000111"
  },
  "description": "Payment for invoice 12345",
  "payment_identifiers": {
    "end_to_end_id": "E2E-20240101-001"
  }
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string
required

Idempotency key

Maximum string length: 255

Body

application/json
​
creditor_account_number_id
string
required

The ID of the Account Number object receiving the instant payment.

Pattern: ^account_number_\w+$
Example:

"account_number_xyz123"

​
amount
integer<int64>
required

The amount of the instant payment in cents.

Required range: x >= 0
Example:

5000

​
currency_code
enum<string>
required

A three-letter currency code as defined in ISO 4217. Only USD is supported.

Available options:
USD
Example:

"USD"

​
debtor
object
required

The details of the debtor (payer) sending the funds.

​
debtor_agent
object
required

The details of the financial institution where the debtor (payer) holds their account.

​
description
string

Free-form information on the reason for the payment.

Example:

"Payment for invoice 12345"

​
payment_identifiers
object

Optional payment identifiers.

Response

Incoming instant payment object created.

The response is of type object.