Pulling funds

Inyo Gateway facilitates pull transactions, a type of financial operation where the payment gateway initiates a request to withdraw funds from a customer's account.

Supports multiple payment methods, including:

  • Credit/Debit Cards

  • ACH Transfers

Fields Definition

Root Object

Field
Type
Required
Description

externalPaymentId

String

βœ…

Client external identifier for the payment.

capture

Boolean

βœ…

true or false

amount

Object

βœ…

Contains the payment amount information.

ipAddress

String

βœ…

IPv4 address of the request origin.

paymentType

String

βœ…

Must be "PULL".

sender

Object

βœ…

Sender information.


amount Object

Field
Type
Required
Constraints
Description

total

Number

βœ…

>= 1

Payment amount

currency

String

βœ…

Must be "USD"

Currency of the transaction


sender Object

customer

Field
Type
Required
Description

firstName

String

βœ…

Customer's first name.

lastName

String

βœ…

Customer's last name.

phoneNumber

String

βœ…

Digits only, 7–15 characters.

documentNumber

String

βœ…

Digits only, 5–20 characters.

documentType

String

βœ…

One of: NATIONAL_ID, PASSPORT, DRIVER_LICENSE

email

String

βœ…

Must be a valid email address.

countryCodeAlpha3

String

βœ…

3-letter uppercase country code (e.g., USA).

customerAddress

Field
Type
Required
Description

stateCode

String

βœ…

US state abbreviation (e.g., MA).

city

String

βœ…

City name.

line1

String

βœ…

Street address line 1.

line2

String

❌

Street address line 2 (optional).

state

String

βœ…

Full state name (e.g., Massachusetts).

zipCode

String

βœ…

Postal code.


source Object

Field
Type
Required
Description

type

String

βœ…

Must be CARD or BANK_ACCOUNT.

🟒 If type = CARD

Field
Type
Required
Description

token

String

βœ…

Must be a valid UUID.

🟒 If type = BANK_ACCOUNT

Field
Type
Required
Description

accountType

String

βœ…

One of: savings, checking, loan, business_checking, business_savings

accountNumber

String

βœ…

6–20 digits.

routingNumber

String

βœ…

Must be 9 digits.

accountHolder

Object

βœ…

Information about the account holder.

accountHolder Object

Field
Type
Required
Description

type

String

βœ…

Either personal or business.

firstName

String

βœ…

First name of the account holder.

lastName

String

βœ…

Last name of the account holder.


Last updated