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 amount details.
ipAddress	string	✅	Must be a valid IPv4 or IPv6 address.
paymentType	string	✅	Must be "PUSH".
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.

---

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_123",
  "amount": {
    "total": 99.90,
    "currency": "USD"
  },
  "ipAddress": "192.168.0.10",
  "paymentType": "PUSH",
  "recipient": {
    "customer": {
      "firstName": "Anna",
      "lastName": "Joseph",
      "phoneNumber": "61992935445",
      "documentNumber": "12345678909",
      "documentType": "NATIONAL_ID",
      "email": "[e-mail]",
      "countryCodeAlpha3": "USA"
    },
    "customerAddress": {
      "stateCode": "SP",
      "city": "São Paulo",
      "line1": "Avenida Paulista 123",
      "line2": "Apto 42",
      "state": "São Paulo",
      "zipCode": "01000-000"
    },
    "destination": {
      "type": "PIX",
      "pix": {
        "keyType": "EMAIL",
        "key": "[e-mail]"
      }
    }
  }
}

---

✅ Example Payload – WALLET

{
  "externalPaymentId": "push_456",
  "amount": {
    "total": 55.00,
    "currency": "USD"
  },
  "ipAddress": "2804:14d:8c80:9b21::1",
  "paymentType": "PUSH",
  "recipient": {
    "customer": {
      "firstName": "Carlos",
      "lastName": "Silva",
      "phoneNumber": "1122334455",
      "documentNumber": "12345678900",
      "documentType": "PASSPORT",
      "email": "[e-mail]",
      "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": "[e-mail]"
      }
    }
  }
}