Skip to main content

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!]!
  batches(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: BatchNodeFilterInput
  ): BatchConnection!
  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]
  cards(
    first: UInt
    last: UInt
    before: Cursor
    after: Cursor
    filter: CardFilterInput
  ): CardConnection!
}

Fields​

id ● ID! non-null scalar​

clientId ● String! non-null scalar​

bankAccounts ● [ClientBankAccount!]! non-null object​

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

batches ● BatchConnection! non-null object​

Returns a list of batches ordered in reverse chronological order.

first ● UInt scalar​

Specifies the maximum number of results to return

last ● UInt scalar​

Specifies the maximum number of results to return for backwards pagination

before ● Cursor scalar​

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

after ● Cursor scalar​

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

filter ● BatchNodeFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

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.

first ● UInt scalar​

Specifies the maximum number of results to return

last ● UInt scalar​

Specifies the maximum number of results to return for backwards pagination

before ● Cursor scalar​

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

after ● Cursor scalar​

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

filter ● PaymentInitiationRequestFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

paymentInitiations ● PaymentInitiationConnection! non-null object​

first ● UInt scalar​

Specifies the maximum number of results to return

last ● UInt scalar​

Specifies the maximum number of results to return for backwards pagination

before ● Cursor scalar​

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

after ● Cursor scalar​

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

filter ● PaymentInitiationFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

verifyBankAccountDetails ● VerifiedBankAccountDetails! non-null object​

This field requires the following scope:

[client_bankaccountverification]

input ● BankAccountVerificationInput! non-null input​

directDeposits ● DirectDepositConnection! non-null object​

first ● UInt scalar​

Specifies the maximum number of results to return

last ● UInt scalar​

Specifies the maximum number of results to return for backwards pagination

before ● Cursor scalar​

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

after ● Cursor scalar​

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

filter ● DirectDepositFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

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]

directorId ● IdentifyingDocumentInput! non-null input​

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

country ● CountryCode! non-null scalar​

The country where the business is registered.

businessByName ● BusinessLookup object​

An array of businesses that match the name provided.

This field requires the following scope:

[client_businesslookup]

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.

country ● CountryCode! non-null scalar​

The country where the business is registered.

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]

input ● BusinessRegistrationInput! non-null input​

refunds ● RefundConnection! non-null object​

This field requires the following scope:

[client_refund]

first ● UInt scalar​
last ● UInt scalar​
before ● Cursor scalar​
after ● Cursor scalar​
filter ● RefundFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

disbursements ● DisbursementConnection! non-null object​

This field requires the following scope:

[client_disbursement]

first ● UInt scalar​
last ● UInt scalar​
before ● Cursor scalar​
after ● Cursor scalar​
filter ● DisbursementFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

settlements ● SettlementConnection! non-null object​

first ● UInt scalar​

Specifies the maximum number of results to return

last ● UInt scalar​

Specifies the maximum number of results to return for backwards pagination

before ● Cursor scalar​

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

after ● Cursor scalar​

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

filter ● SettlementFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

subscriptions ● ClientSubscriptionDetails object​

This field requires the following scope:

[client_paymentrequest]

webhookLogin ● WebhookLoginResponse object​

webhookEndpoints ● [Endpoint] list object​

filter ● [String!] list scalar​

cards ● CardConnection! non-null object​

first ● UInt scalar​

Specifies the maximum number of results to return

last ● UInt scalar​

Specifies the maximum number of results to return for backwards pagination

before ● Cursor scalar​

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

after ● Cursor scalar​

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

filter ● CardFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

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.