paymentsAndRepaymentsForPrm

Fetch the payments and repayments for an account and for a specific PRM.

Deprecation

The 'paymentsAndRepaymentsForPrm' field is deprecated.

Replaced for a generic query to obtain payments and repayments. Please use 'paymentsAndRepayments' instead.

- Marked as deprecated on 2024-04-01.
- Scheduled for removal on or after 2024-12-01.

Arguments

accountNumber : String!


            required

ID of the account.

after : String

before : String

first : Int

fromDate : Date

Optional date representing the beginning of the search results. This date value is inclusive.

last : Int

paymentReason : PaymentReasonOptions

Filter for payments that were taken for a particular reason.

paymentStatus : AccountPaymentStatusOptions

Filter on the payments status.

prmId : String!


            required

ID of the PRM.

repaymentStatuses : [AccountRepaymentStatusOptions]

Only return repayments whose status matches one of these statuses.

toDate : Date

Optional date representing the end of the search results. This date value is exclusive.

Returns

FraAccountPaymentConnectionTypeConnection

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query PaymentsAndRepaymentsForPrm(
  $accountNumber: String!,
  $after: String,
  $before: String,
  $first: Int,
  $fromDate: Date,
  $last: Int,
  $paymentReason: PaymentReasonOptions,
  $paymentStatus: AccountPaymentStatusOptions,
  $prmId: String!,
  $repaymentStatuses: [AccountRepaymentStatusOptions],
  $toDate: Date
) {
  paymentsAndRepaymentsForPrm(
    accountNumber: $accountNumber,
    after: $after,
    before: $before,
    first: $first,
    fromDate: $fromDate,
    last: $last,
    paymentReason: $paymentReason,
    paymentStatus: $paymentStatus,
    prmId: $prmId,
    repaymentStatuses: $repaymentStatuses,
    toDate: $toDate
  ) {
    edgeCount
    edges {
      ...FraAccountPaymentConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

{
  "accountNumber": "A-28884CAC",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "fromDate": "1982-04-21",
  "last": 10,
  "paymentReason": "BALANCE_THRESHOLD_CROSSED",
  "paymentStatus": "SCHEDULED",
  "prmId": "57843467",
  "repaymentStatuses": "REQUESTED",
  "toDate": "2013-06-21"
}

{
  "data": {
    "paymentsAndRepaymentsForPrm": {
      "edgeCount": 93,
      "edges": [FraAccountPaymentConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 73
    }
  }
}