preparePaymentMethod

This query allows to prepare the requested payment method.

General Pattern

query{
  preparePaymentMethod(orgID:UUID1 paymentMethodType:PaymentType!){
    field_1
  }
}

Sample query

query{
  preparePaymentMethod(orgID:"8fb128bd-f55d-4bcc-8b6c-0beb684e4d4e"
  paymentMethodType: ACH){
    ... on ACHPaymentMethodPrepareStatementOutput{
      linkToken
    }
  }
}

Sample response

{
  "data": {
    "preparePaymentMethod": {
      "linkToken": "link-sandbox-fbd2de1f-b247-4911-b783-979238b4b751"
    }
  }
}

Arguments

Name

Type

Description

Required

paymentMethodType

enum

The requested payment method. The value can be either ACH, Wire or CreditCard.

Yes

orgID

UUID

The organization ID.

Yes.

Returns

Name

Type

Description

PaymentMethodPrepareStatementOutput

object

An object loaded by link token.

Example

Create a payment method preparation using ACH and organization ID: