Inyo

Pulling Funds

Pull (collect) transactions withdraw funds from a customer's payment method. The Inyo Gateway supports:

  • Credit/Debit Cards — Via tokenized card data (see Tokenizing Cards)
  • ACH Bank Transfers — Via bank account and routing number

All pull transactions use the same endpoint:

POST https://{FQDN}/v2/payment

Request Structure

Root Object

FieldTypeRequiredDescription
externalPaymentIdstring✅Your unique payment identifier (idempotency key)
ipAddressstring✅Payer's IPv4 or IPv6 address
paymentTypestring✅"PULL"
captureboolean✅true = auto-capture; false = pre-auth only (cards only)
amountobject✅Transaction amount
senderobject✅Payer information, address, and payment method

amount Object

FieldTypeRequiredDescription
totalnumber✅Payment amount (must be ≥ 1)
currencystring✅ISO 4217 currency code (e.g., "USD")

sender Object

FieldTypeRequiredDescription
firstNamestring✅Payer's first name
lastNamestring✅Payer's last name
addressobject✅Billing address
paymentMethodobject✅Card or bank account details

sender.address Object

FieldTypeRequiredDescription
countryCodestring✅ISO Alpha-2 country code (e.g., "US")
stateCodestring✅State abbreviation (e.g., "NY")
citystring✅City name
line1string✅Street address line 1
line2string❌Street address line 2
zipCodestring✅Postal/ZIP code

sender.paymentMethod — Card

FieldTypeRequiredDescription
typestring✅"CARD"
cardTokenIdstring✅Token UUID from the tokenizer
previousPaymentIdstring❌For recurring tokens: paymentId from the initial authorization

sender.paymentMethod — Bank Account (ACH)

FieldTypeRequiredDescription
typestring✅"BANK_DEPOSIT"
accountNumberstring✅Bank account number (6–20 digits)
routingNumberstring✅ABA routing number (9 digits)
accountTypestring✅"CHECKING", "SAVINGS", "BUSINESS_CHECKING", or "BUSINESS_SAVINGS"

Card Payment Lifecycle

Tokenize → Authorize → (3DS Challenge?) → Capture → (Refund?)
                                              ↘ Void

For card payments:

  1. Authorize — Create the payment ("capture": false for pre-auth)
  2. Handle 3DS — If status = CHALLENGE, redirect to redirectAcsUrl
  3. Capture — Settle the authorized payment (within 7 days)
  4. Void — Cancel before capture
  5. Refund — Return funds after capture (full or partial)

ACH Payments

ACH payments are always captured immediately ("capture": true). The pre-auth/capture lifecycle does not apply.

See ACH (Bank Account) for a complete example.

What's Next

GuideDescription
Card AuthorizationFull card payment flow with examples
ACH PaymentBank account pull with example payload
3D SecureChallenge redirect handling
AVS / CVCAddress and security code verification
CaptureSettle a pre-authorized payment
VoidCancel before settlement
RefundReturn funds after capture
PreviousPaymentNextCards