Client

Data available to requests that have client tokens. Implements the Relay GraphQL Server Specification.

type Client implements Node {
  id: ID!
  clientId: String!
  bankAccounts: [ClientBankAccount!]!
  paymentInitiationRequests(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: PaymentInitiationRequestFilterInput
  ): PaymentInitiationRequestConnection!
  paymentInitiations(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: PaymentInitiationFilterInput
  ): PaymentInitiationConnection!
  verifyBankAccountDetails(
    input: BankAccountVerificationInput!
  ): VerifiedBankAccountDetails!
  directDeposits(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: DirectDepositFilterInput
  ): DirectDepositConnection!
  businessesByDirectorId(
    directorId: IdentifyingDocumentInput!
    country: CountryCode!
  ): [BusinessLookup!]!
  businessByName(
    businessName: String!
    country: CountryCode!
  ): BusinessLookup
  businessByRegistrationNumber(
    input: BusinessRegistrationInput!
  ): BusinessLookup
  refunds(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: RefundFilterInput
  ): RefundConnection!
  disbursements(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: DisbursementFilterInput
  ): DisbursementConnection!
  settlements(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: SettlementFilterInput
  ): SettlementConnection!
  subscriptions: ClientSubscriptionDetails
  webhookLogin: WebhookLoginResponse
  webhookEndpoints(
    filter: [String!]
  ): [Endpoint]
  walletRefundTransactions(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: WalletRefundTransactionFilterInput
  ): WalletRefundTransactionConnection!
  walletTransactions(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: WalletTransactionNodeFilterInput
  ): WalletTransactionConnection!
  paymentCollections(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: PaymentCollectionFilterInput
  ): PaymentCollectionConnection!
  transactions(
    filter: PaymentTransactionsFilterInput
  ): PaymentTransactionConnection!
}

Fields

Client.id ● ID! non-null scalar

Client.clientId ● String! non-null scalar

Client.bankAccounts ● [ClientBankAccount!]! non-null object

Returns a list of accounts that are configured on the client.

Client.paymentInitiationRequests ● PaymentInitiationRequestConnection! non-null object

Payment requests are ordered in *reverse chronological* order.

The first parameter can be used to set the number of payment requests to return, up to a maximum of 2000 payment requests.

Client.paymentInitiationRequests.first ● UInt scalar

Specifies the maximum number of results to return

Client.paymentInitiationRequests.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Client.paymentInitiationRequests.before ● Cursor scalar

Takes in the paging cursor. The next page of results will start after this cursor

Client.paymentInitiationRequests.after ● Cursor scalar

Takes in the paging cursor. The previous page of results will start before this cursor

Client.paymentInitiationRequests.filter ● PaymentInitiationRequestFilterInput input

Client.paymentInitiations ● PaymentInitiationConnection! non-null object

Client.paymentInitiations.first ● UInt scalar

Specifies the maximum number of results to return

Client.paymentInitiations.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Client.paymentInitiations.before ● Cursor scalar

Takes in the paging cursor. The next page of results will start after this cursor

Client.paymentInitiations.after ● Cursor scalar

Takes in the paging cursor. The previous page of results will start before this cursor

Client.paymentInitiations.filter ● PaymentInitiationFilterInput input

Client.verifyBankAccountDetails ● VerifiedBankAccountDetails! non-null object

This field requires the following scope:

[client_bankaccountverification]

Client.verifyBankAccountDetails.input ● BankAccountVerificationInput! non-null input

Client.directDeposits ● DirectDepositConnection! non-null object

Client.directDeposits.first ● UInt scalar

Specifies the maximum number of results to return

Client.directDeposits.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Client.directDeposits.before ● Cursor scalar

Takes in the paging cursor. The next page of results will start after this cursor

Client.directDeposits.after ● Cursor scalar

Takes in the paging cursor. The previous page of results will start before this cursor

Client.directDeposits.filter ● DirectDepositFilterInput input

Client.businessesByDirectorId ● [BusinessLookup!]! non-null object

A list of business names and registration numbers for a given identity or passport number of a director. If using a test client, querying with a South African identity "1234567890" will return an example response.

This field requires the following scope:

[client_businesslookup]

Client.businessesByDirectorId.directorId ● IdentifyingDocumentInput! non-null input

The identity or passport number of a director of the business.

Client.businessesByDirectorId.country ● CountryCode! non-null scalar

The country where the business is registered.

Client.businessByName ● BusinessLookup object

An array of businesses that match the name provided.

This field requires the following scope:

[client_businesslookup]

Client.businessByName.businessName ● String! non-null scalar

The case-insensitive name of the business. If using a test client, the name 'Fizz Buzz' will return an example response.

Client.businessByName.country ● CountryCode! non-null scalar

The country where the business is registered.

Client.businessByRegistrationNumber ● BusinessLookup object

Returns a business for a given registration number, or null if no business with that registration number is found. If using a test client, the registration number 'K1234567890' or '1234/567890/07' will return an example response.

This field requires the following scope:

[client_businesslookup]

Client.businessByRegistrationNumber.input ● BusinessRegistrationInput! non-null input

Client.refunds ● RefundConnection! non-null object

This field requires the following scope:

[client_refund]

Client.refunds.first ● UInt scalar

Specifies the maximum number of results to return

Client.refunds.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Client.refunds.before ● Cursor scalar

Takes in the paging cursor. The next page of results will start after this cursor

Client.refunds.after ● Cursor scalar

Takes in the paging cursor. The previous page of results will start before this cursor

Client.refunds.filter ● RefundFilterInput input

Client.disbursements ● DisbursementConnection! non-null object

This field requires the following scope:

[client_disbursement]

Client.disbursements.first ● UInt scalar

Specifies the maximum number of results to return

Client.disbursements.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Client.disbursements.before ● Cursor scalar

Takes in the paging cursor. The next page of results will start after this cursor

Client.disbursements.after ● Cursor scalar

Takes in the paging cursor. The previous page of results will start before this cursor

Client.disbursements.filter ● DisbursementFilterInput input

Client.settlements ● SettlementConnection! non-null object

Client.settlements.first ● UInt scalar

Specifies the maximum number of results to return

Client.settlements.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Client.settlements.before ● Cursor scalar

Takes in the paging cursor. The next page of results will start after this cursor

Client.settlements.after ● Cursor scalar

Takes in the paging cursor. The previous page of results will start before this cursor

Client.settlements.filter ● SettlementFilterInput input

Client.subscriptions ● ClientSubscriptionDetails object

This field requires the following scope:

[client_paymentrequest]

Client.webhookLogin ● WebhookLoginResponse object

TODO(PLA-2751): Add required scope here

Client.webhookEndpoints ● [Endpoint] list object

Client.webhookEndpoints.filter ● [String!] list scalar

Client.walletRefundTransactions ● WalletRefundTransactionConnection! non-null object

This field requires the following scope:

[client_refund]

Client.walletRefundTransactions.first ● UInt scalar

Specifies the maximum number of results to return

Client.walletRefundTransactions.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Client.walletRefundTransactions.before ● Cursor scalar

Takes in the paging cursor. The next page of results will start after this cursor

Client.walletRefundTransactions.after ● Cursor scalar

Takes in the paging cursor. The previous page of results will start before this cursor

Client.walletRefundTransactions.filter ● WalletRefundTransactionFilterInput input

Client.walletTransactions ● WalletTransactionConnection! non-null object

Client.walletTransactions.first ● UInt scalar

Specifies the maximum number of results to return

Client.walletTransactions.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Client.walletTransactions.before ● Cursor scalar

Takes in the paging cursor. The next page of results will start after this cursor

Client.walletTransactions.after ● Cursor scalar

Takes in the paging cursor. The previous page of results will start before this cursor

Client.walletTransactions.filter ● WalletTransactionNodeFilterInput input

Client.paymentCollections ● PaymentCollectionConnection! non-null object

Client.paymentCollections.first ● UInt scalar

Specifies the maximum number of results to return

Client.paymentCollections.last ● UInt scalar

Specifies the maximum number of results to return for backwards pagination

Client.paymentCollections.before ● Cursor scalar

Takes in the paging cursor. The next page of results will start after this cursor

Client.paymentCollections.after ● Cursor scalar

Takes in the paging cursor. The previous page of results will start before this cursor

Client.paymentCollections.filter ● PaymentCollectionFilterInput input

Client.transactions ● PaymentTransactionConnection! non-null object

Client.transactions.filter ● PaymentTransactionsFilterInput input

Interfaces

Node interface

An abstract datatype that has a locally unique identifier, allowing a given node to be later queried by id using the node(id: ID!) query.