requestedPayments

Overview

This query returns a list of all active requested payments from the account in the current login session.

Special Considerations

  • Query does not require any inputs

Inputs

N/A

Returns

Promise<RequestedPayment[]>

A promise containing an array of RequestedPayment(s), in which each object contains:

RequestedPayment: {
  id: string,
  amount: float,
  description: string,
  date: DateTime,
  currency: CURRENCY,
  contact: Contact
}

Example

Running this query:

query {
  requestedPayments {
    id
    amount
    description
    date
    currency
    contact {
      account {
        accountType
        displayName
        currency
        slug
      }
      email
    }
  }
}

Gives us:

{
  "data": {
    "requestedPayments": [
      "id": "ckb9gcl8p003e0a72nrvqwkd0",
      "amount": 25,
      "description": "test1",
      "date": "2020-06-10T14:32:23.537Z",
      "currency": "CAD",
      "contact": {
        "account": {
          "accountType": "BUSINESS",
          "displayName": "Test Business",
          "currency": "CAD",
          "slug": "testbusiness"
        },
      "email": "aaron.n@getborderless.com"
      }
    ]
  }
}

Common Errors

N/A

← paymentSessiontradeConfirmationForPayment →