v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB

Instant Payments

List all instant payments

List instant payments with optional filtering.

get/v1/instant_payments

Query parameters

account_idstring

Returns instant payments associated with this account_id.

account_number_idstring

Returns instant payments associated with this account_number_id.

direction'outgoing' | 'incoming'

Who is initiating the transaction.

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

Example:outgoing

Returns instant payments with the given direction.

status'created' | 'under_review' | 'canceled' | 'rejected' | 'posted'

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

Example:posted

Returns instant payments with the given status.

counterparty_status'posted' | 'under_review' | 'rejected' nullable

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

Example:posted

Returns instant payments with the given counterparty status.

return_request_status'pending' | 'response_needed' | 'accepted' | 'rejected'

The current status of the return request object. For incoming return requests: response_needed, accepted, rejected. For outgoing return requests: pending, accepted, rejected.

Example:pending

Returns instant payments that have a return request with the given status.

afterstring date-time

Returns objects where the created_at timestamp is after the entered timestamp.

on_or_afterstring date-time

Returns objects where the created_at timestamp is the same as or after the entered timestamp.

beforestring date-time

Returns objects where the created_at timestamp is before the entered timestamp.

on_or_beforestring date-time

Returns objects where the created_at timestamp is the same as or before the entered timestamp.

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

limitinteger

Maximum number of objects to be returned.

starting_afterstring

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

ending_beforestring

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

Response

A list of instant payment objects.

has_moreboolean required

Indicates whether more results are available.

Example response

{
  "objects": [
    {
      "id": "instant_payment_xyz123",
      "account_id": "account_xyz123",
      "account_number_id": "account_number_xyz123",
      "direction": "outgoing",
      "status": "posted",
      "counterparty_status": "posted",
      "amount": 5000,
      "currency_code": "USD",
      "description": "Payment for invoice 12345",
      "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": "033me5upSkktRorr3J6TKZ",
        "uetr": "8dc981d2-e8c2-4a7b-8df0-0781b46328d9",
        "transaction_id": "3G0CQxK8gKLpzaaxc7A9spDiifK"
      },
      "return": {
        "reason": "duplication"
      },
      "rejection": {
        "rejected_by": "lead",
        "reason": "non_sufficient_funds"
      },
      "related_objects": {
        "original_payment_id": "instant_payment_xyz123",
        "return_payment_ids": [
          "instant_payment_xyz456"
        ]
      },
      "return_requests": [
        {
          "status": "pending",
          "reason": "duplicate",
          "deadline": "2022-07-11T23:30:00-04:00",
          "resolution": {
            "resolved_at": "2022-06-27T11:22:33Z",
            "resolved_by": "counterparty",
            "rejection_reason": "customer_no_response"
          },
          "created_at": "2022-06-27T11:22:33Z"
        }
      ],
      "created_at": "2022-06-27T11:22:33Z",
      "updated_at": "2022-06-27T11:22:40Z"
    }
  ]
}