Skip to main content
GET
/
v1
/
instant_payments
List all instant payments
curl --request GET \
  --url https://api.sandbox.lead.bank/v1/instant_payments \
  --header 'Authorization: Bearer <token>'
{
  "objects": [
    {
      "id": "instant_payment_xyz123",
      "account_id": "account_xyz123",
      "account_number_id": "account_number_xyz123",
      "direction": "outgoing",
      "status": "posted",
      "amount": 5000,
      "currency_code": "USD",
      "debtor": {
        "name": "Alex Smith",
        "account_number": "1234567890"
      },
      "debtor_agent": {
        "routing_number": "111000111"
      },
      "creditor_agent": {
        "routing_number": "111000111"
      },
      "creditor": {
        "name": "Alex Smith",
        "account_number": "1234567890"
      },
      "payment_identifiers": {
        "end_to_end_id": "E2E-20240101-001",
        "uetr": "8dc981d2-e8c2-4a7b-8df0-0781b46328d9",
        "transaction_id": "TXN-20240101-001"
      },
      "return": {
        "reason": "duplicate",
        "details": "<string>"
      },
      "rejection": {
        "rejected_by": "lead",
        "reason": "non_sufficient_funds",
        "details": "<string>"
      },
      "related_objects": {
        "original_payment_id": "instant_payment_xyz123",
        "return_payment_ids": [
          "instant_payment_xyz456"
        ]
      },
      "return_requests": [
        {
          "status": "pending",
          "reason": "duplicate",
          "created_at": "2022-06-27T11:22:33Z",
          "details": "<string>",
          "deadline": "2022-07-11T23:30:00-04:00",
          "resolution": {
            "resolved_at": "2022-06-27T11:22:33Z",
            "resolved_by": "counterparty",
            "accepted_amount": 5000,
            "rejection_reason": "no_answer_from_customer",
            "rejection_details": "<string>"
          }
        }
      ],
      "created_at": "2022-06-27T11:22:33Z",
      "updated_at": "2022-06-27T11:22:40Z",
      "counterparty_status": "posted",
      "description": "Payment for invoice 12345"
    }
  ],
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
account_id
string

Returns instant payments associated with this account_id.

Pattern: ^account_\w+$
​
account_number_id
string

Returns instant payments associated with this account_number_id.

Pattern: ^account_number_\w+$
​
direction
enum<string>

Returns instant payments with the given direction. Who is initiating the transaction.

outgoing: You are sending a transaction to a counterparty. incoming: You are receiving a transaction from a counterparty.

Available options:
outgoing,
incoming
Example:

"outgoing"

​
status
enum<string>

Returns instant payments with the given status. The current status of the instant payment object. If outgoing: created, under_review, canceled, rejected, posted. If incoming: under_review, rejected, posted.

Available options:
created,
under_review,
canceled,
rejected,
posted
Example:

"posted"

​
counterparty_status
enum<string> | null

Returns instant payments with the given counterparty status. The current status of the instant payment from the counterparty's perspective. If outgoing: posted, under_review, or rejected. If incoming: posted or null.

Available options:
posted,
under_review,
rejected
Example:

"posted"

​
return_request_status
enum<string>

Returns instant payments that have a return request with the given status. The current status of the return request object. For incoming return requests: response_needed, accepted, rejected. For outgoing return requests: pending, accepted, rejected.

Available options:
pending,
response_needed,
accepted,
rejected
Example:

"pending"

​
created_at
object

A set of filters on the list using the object's field created_at.

​
limit
integer
default:10

Maximum number of objects to be returned.

Required range: 1 <= x <= 100
​
starting_after
string

A cursor for use in pagination; this is an ID that defines your place in the list.

Pattern: ^instant_payment_\w+$
​
ending_before
string

A cursor for use in pagination; this is an ID that defines your place in the list.

Pattern: ^instant_payment_\w+$

Response

A list of instant payment objects.

​
objects
object[]
required
​
has_more
boolean
required

Indicates whether more results are available.