Push Transaction

Inyo Gateway also supports push transactions, a type of financial operation where the payment gateway facilitates the transfer of funds initiated by the sender to a recipient’s account, globally.

Supports multiple payment methods, including:

• Credit/Debit Cards (domestic and cross-border)

• ACH Transfers (domestic)

• Accounts (cross-border)

Root Object

Field	Type	Required	Description
externalPaymentId	string	✅	External identifier for the payment.
amount	object	✅	Payment source amount details.
recipientAmount	string	✅	Payment recipient amount details.
paymentType	string	✅	Must be "PUSH".
ipAddress	object	✅	Must be a valid IPv4 or IPv6 address.
sender	object	✅	Contains sender details.
recipient	object	✅	Contains recipient details.

---

amount object

Field	Type	Required	Validation	Description
total	number	✅	Must be >= 1	Amount to be sent.
currency	string	✅	Must be "USD"	Currency used in the payment.

---

recipientAmount object

Field	Type	Required	Validation	Description
total	number	✅	Must be ≥ 1	Amount to be received.
currency	string	✅	3-letter ISO code	Currency of recipient amount.

sender Object

customer

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

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.

recipient object

customer

Field	Type	Required	Validation	Description
firstName	string	✅	—	Recipient's first name.
lastName	string	✅	—	Recipient's last name.
phoneNumber	string	✅	7–15 digits (only numbers)	Recipient's phone number.
documentNumber	string	✅	5–20 digits	Recipient's document number.
documentType	string	✅	NATIONAL_ID, PASSPORT, DRIVER_LICENSE	Type of document.
email	string	✅	Must be a valid email	Recipient's email address.
countryCodeAlpha3	string	✅	3-letter uppercase (e.g., USA)	ISO Alpha-3 country code.

customerAddress

Field	Type	Required	Description
stateCode	string	✅	State code (e.g., SP).
city	string	✅	City name.
line1	string	✅	Street address (line 1).
line2	string	❌	Street address (line 2 - optional).
state	string	✅	Full state name (e.g., São Paulo).
zipCode	string	✅	ZIP/postal code.

---

destination object

Field	Type	Required	Description
type	string	✅	Must be "PIX" or "WALLET"

🟢 If type = PIX

Field	Type	Required	Validation	Description
keyType	string	✅	EMAIL, PHONE, DOCUMENT, EVP	Type of PIX key
key	string	✅	—	PIX key value

🟢 If type = WALLET

Field	Type	Required	Description
walletId	string	✅	Wallet identifier (email or ID)

---

✅ Example Payload – PIX

{
    "externalPaymentId": "push_456",
    "amount": {
        "total": 55.00,
        "currency": "USD"
    },
    "recipientAmount": {
        "total": 57.9026948,
        "currency": "BRL"
    },
    "ipAddress": "2804:14d:8c80:9b21::1",
    "paymentType": "PUSH",
    "sender": {
        "customer": {
            "firstName": "Bob Danilo",
            "lastName": "Bob Danilo",
            "phoneNumber": "[phone]",
            "documentNumber": "050482156",
            "documentType": "NATIONAL_ID",
            "email": "[email protected]",
            "countryCodeAlpha3": "USA"
        },
        "customerAddress": {
            "stateCode": "CA",
            "city": "LAKEWOOD",
            "line1": "4429 CANDLEWOOD ST",
            "line2": "Some line 2 address",
            "zipCode": "90712",
            "countryCode": "US"
        }
    },
    "recipient": {
        "customer": {
            "firstName": "Carlos",
            "lastName": "Silva",
            "phoneNumber": "1122334455",
            "documentNumber": "12345678900",
            "documentType": "PASSPORT",
            "email": "[email protected]",
            "countryCodeAlpha3": "BRA"
        },
        "customerAddress": {
            "stateCode": "RJ",
            "city": "Rio de Janeiro",
            "line1": "Rua das Laranjeiras 321",
            "state": "Rio de Janeiro",
            "zipCode": "22240-005"
        },
        "destination": {
            "type": "PIX",
            "pix": {
                "keyType": "CPF",
                "key": "01034861788"
            }
        }
    }
}

---

✅ Example Payload – WALLET

{
    "externalPaymentId": "push_456",
    "amount": {
        "total": 55.00,
        "currency": "USD"
    },
    "recipientAmount": {
        "total": 57.9026948,
        "currency": "BRL"
    },
    "ipAddress": "2804:14d:8c80:9b21::1",
    "paymentType": "PUSH",
    "sender": {
        "customer": {
            "firstName": "Bob Danilo",
            "lastName": "Bob Danilo",
            "phoneNumber": "[phone]",
            "documentNumber": "050482156",
            "documentType": "NATIONAL_ID",
            "email": "[email protected]",
            "countryCodeAlpha3": "USA"
        },
        "customerAddress": {
            "stateCode": "CA",
            "city": "LAKEWOOD",
            "line1": "4429 CANDLEWOOD ST",
            "line2": "Some line 2 address",
            "zipCode": "90712",
            "countryCode": "US"
        }
    },
    "recipient": {
        "customer": {
            "firstName": "Carlos",
            "lastName": "Silva",
            "phoneNumber": "1122334455",
            "documentNumber": "12345678900",
            "documentType": "PASSPORT",
            "email": "[email protected]",
            "countryCodeAlpha3": "BRA"
        },
        "customerAddress": {
            "stateCode": "RJ",
            "city": "Rio de Janeiro",
            "line1": "Rua das Laranjeiras 321",
            "state": "Rio de Janeiro",
            "zipCode": "22240-005"
        },
        "destination": {
            "type": "WALLET",
            "wallet": {
                "walletId": "[email protected]"
            }
        }
    }
}