paymentActivity

Overview

This query gets the payment activity of requests,payments, and refunds of the current account during the current login session.

Special Considerations

None.

Inputs

None.

Returns

Promise<PaymentEntry[]>

Returns a promise containing an array of Payment Entries.

where each of these is a mapped array of PaymentEntry(s) containing the relevant information.

PaymentEntry: {
    id: string,
    type: PaymentEntryType,
    subAmount: float
    totalAmount: float,
    totalFeeAmount: float,
    description: string,
    estimatedArrival: string,
    valueDate: DateTime,
    createdAt: DateTime,
    message: string,
    contact: Contact,
    status: PaymentEntryStatus,
    currency: CURRENCY,
    reason: RefundReason,
    refundType: RefundType,
    paymentMethod: string,
    tradeNumber: string,
    savingsAmount: float,
    sessionType: PaymentSessionType
    originalPayment: OriginalPayment,
    refunds: [RefundDisplayData],
    paymentRequestLink: string,
    refundLimitReached: boolean
}

Example

Running this query:

query {
    paymentActivity {
        id
        type
        subAmount
        totalAmount
        totalFeeAmount
        description
        estimatedArrival
        valueDate
        createdAt
        message
        contact {
          account {
            accountType
            displayName
          }
          email
        }
        status
        currency
        reason
        refundType
    }
}

Gives us:

{
    "data": {
        "paymentActivity": [
        {
            "id": "ckb9rcvtt006m0729ec8e7atn",
            "type": "CREATED_PAYMENT_REQUEST",
            "subAmount": 50,
            "totalAmount": 50,
            "totalFeeAmount": null,
            "description": "testing purposes 2",
            "estimatedArrival": null,
            "valueDate": "1995-10-09T00:00:00.000Z",
            "createdAt": "2020-06-10T19:40:33.952Z",
            "message": null,
            "contact": {
              "account": null,
              "email": "alexander.l@getborderless.com"
            },
            "status": "REQUESTED",
            "currency": "AUD",
            "reason": null,
            "refundType": null
        },
        {
            "id": "ckb9rdzif00710729541mulq8",
            "type": "CREATED_PAYMENT_REQUEST",
            "subAmount": 50,
            "totalAmount": 50,
            "totalFeeAmount": null,
            "description": "testing purposes 1",
            "estimatedArrival": null,
            "valueDate": "1992-10-09T00:00:00.000Z",
            "createdAt": "2020-06-10T19:41:25.377Z",
            "message": null,
            "contact": {
              "account": null,
              "email": "aaron.n@getborderless.com"
            },
            "status": "REQUESTED",
            "currency": "USD",
            "reason": null,
            "refundType": null
        }
        ]
    }
}

Common Errors