getPaymentMethodList

This query loads the information of the payment method list.

General Pattern

query{
    getPaymentMethodList(orgId: "UUID1"){
    field_1
    field_2 {
       nested_field_1
       ...
    }
  }
}

Sample query

query{
  getPaymentMethodList(orgID:"8fb128bd-f55d-4bcc-8b6c-0beb684e4d4e"){
    ... on CreditCardPaymentMethodOutput{
      id
      type
      status
      network
      last4Digit
      metadata{
        email
        phoneNumber
      }
      billingDetails{
        name
        address1
        address2
        country
        district
        city
        postalCode
      }
    }
  }
}

Sample response

{
  "data": {
    "getPaymentMethodList": [
      {
        "id": "b2f5cdfd-3550-47ab-a5a2-e21731724ea7",
        "type": "CreditCard",
        "status": "complete",
        "network": "VISA",
        "last4Digit": "0006",
        "metadata": {
          "email": "[email protected]",
          "phoneNumber": "+22980295837678"
        },
        "billingDetails": {
          "name": "Denis Avramenko",
          "address1": "bl",
          "address2": "",
          "country": "BJ",
          "district": "LI",
          "city": "Krichev",
          "postalCode": "213510"
        }
      }
    ]
  }
}

Arguments

Name

Type

Description

Required

orgID

UUID1

The organization ID.

Yes

Fields

Name

Type

Description

PaymentMethodOutput

Object

Union from Object CreditCardPaymentMethodOutput, Object ACHPaymentMethodOutput and Object WirePaymentMethodOutput

Example

Load the payment method list using an organization ID: