Inyo

Americas

A complete POST /v2/payment body for each validated payout corridor in the Americas. Expand a country to see it.

Each body here is a payload the gateway accepted in corridor testing, with only the environment metadata replaced — externalPaymentId, fxId, ipAddress, and the sender's name. The account numbers, bank codes, wallet identifiers, purpose codes, and amounts are the ones that were actually submitted.

Every body on this page validates against its country schema and against the generic push schema. Swap in your own externalPaymentId, a live fxId from Foreign Exchange, and real recipient details before sending. See Country coverage for what each corridor requires.

Brazil — BRA · BRL · BANK_DEPOSIT · PIX · schema v1.0.1

BANK_DEPOSIT — tested

{
  "externalPaymentId": "push-bra-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 100,
    "currency": "BRL"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "line2": "",
      "zipCode": "AAAAA"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "address": {
      "countryCode": "BRA",
      "stateCode": "AC",
      "city": "Test City",
      "line1": "123 Main Street",
      "zipCode": "01310100"
    },
    "paymentMethod": {
      "type": "BANK_DEPOSIT",
      "countryCode": "BRA",
      "bankCode": "341",
      "routingNumber": "0001",
      "accountNumber": "12345678901",
      "accountType": "CHECKING"
    },
    "documents": [
      {
        "document": "12345678909",
        "type": "CPF",
        "countryCode": "BRA"
      }
    ]
  },
  "additionalData": {
    "senderSourceOfFunds": "01",
    "statementNarrative": "Family support"
  }
}

PIX — tested

{
  "externalPaymentId": "push-bra-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 101,
    "currency": "BRL"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "address": {
      "countryCode": "BRA",
      "stateCode": "SP",
      "city": "Sao Paulo",
      "line1": "Rua Test 123",
      "zipCode": "01310100"
    },
    "paymentMethod": {
      "type": "PIX",
      "countryCode": "BRA",
      "keyType": "RANDOM",
      "key": "4fbdefaf-dec8-4ace-8b1a-1c2d3e4f5a6b"
    },
    "documents": [
      {
        "document": "12345678909",
        "type": "CPF",
        "countryCode": "BRA"
      }
    ]
  },
  "additionalData": {}
}

Canada — CAN · CAD · BANK_DEPOSIT · schema v1.0.1

BANK_DEPOSIT — tested

{
  "externalPaymentId": "push-can-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 28,
    "currency": "CAD"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "line2": "",
      "zipCode": "AAAAA"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "address": {
      "countryCode": "CAN",
      "stateCode": "AB",
      "city": "Test City",
      "line1": "123 Main Street",
      "zipCode": "T1L1C1"
    },
    "paymentMethod": {
      "type": "BANK_DEPOSIT",
      "countryCode": "CAN",
      "bankCode": "003",
      "routingNumber": "00001",
      "accountNumber": "1234567",
      "accountType": "CHECKING"
    },
    "phoneNumber": "+14165551234"
  },
  "additionalData": {
    "paymentPurpose": "601",
    "statementNarrative": "Family support"
  }
}

Chile — CHL · CLP · BANK_DEPOSIT · schema v1.0.1

BANK_DEPOSIT — tested

{
  "externalPaymentId": "push-chl-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 18240,
    "currency": "CLP"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "line2": "",
      "zipCode": "AAAAA"
    }
  },
  "recipient": {
    "firstName": "Maria",
    "lastName": "Gonzalez",
    "address": {
      "countryCode": "CHL",
      "city": "Santiago",
      "line1": "Av. Libertador 456",
      "zipCode": "8320000"
    },
    "paymentMethod": {
      "type": "BANK_DEPOSIT",
      "countryCode": "CHL",
      "bankCode": "012",
      "accountNumber": "1234567890",
      "accountType": "CHECKING"
    },
    "documents": [
      {
        "document": "123456785",
        "type": "RUT",
        "countryCode": "CHL"
      }
    ]
  },
  "additionalData": {
    "statementNarrative": "Family support"
  }
}

Colombia — COL · COP · BANK_DEPOSIT · schema v1.0.1

BANK_DEPOSIT — tested

{
  "externalPaymentId": "push-col-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 63599,
    "currency": "COP"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "line2": "",
      "zipCode": "AAAAA"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "[email protected]",
    "address": {
      "countryCode": "COL",
      "stateCode": "AMA",
      "city": "Test City",
      "line1": "123 Main Street",
      "zipCode": "110001"
    },
    "paymentMethod": {
      "type": "BANK_DEPOSIT",
      "countryCode": "COL",
      "bankCode": "007",
      "routingNumber": "11111",
      "accountNumber": "12345678901234",
      "accountType": "CHECKING"
    },
    "documents": [
      {
        "document": "1014357612",
        "type": "CC",
        "countryCode": "COL"
      }
    ],
    "phoneNumber": "+573001234567"
  },
  "additionalData": {
    "paymentPurpose": "EPFAMT"
  }
}

Mexico — MEX · MXN · BANK_DEPOSIT · schema v1.0.1

BANK_DEPOSIT · BBAN — tested

{
  "externalPaymentId": "push-mex-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 346,
    "currency": "MXN"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "line2": "",
      "zipCode": "AAAAA"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "address": {
      "countryCode": "MEX",
      "stateCode": "AGU",
      "city": "Test City",
      "line1": "123 Main Street",
      "zipCode": "12345"
    },
    "paymentMethod": {
      "type": "BANK_DEPOSIT",
      "countryCode": "MEX",
      "accountNumberType": "BBAN",
      "accountNumber": "012180012345678909",
      "accountType": "CHECKING"
    },
    "phoneNumber": "+5215512345678"
  },
  "additionalData": {}
}

BANK_DEPOSIT · DIMO — tested

{
  "externalPaymentId": "push-mex-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 347,
    "currency": "MXN"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "line2": "",
      "zipCode": "AAAAA"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "address": {
      "countryCode": "MEX",
      "stateCode": "AGU",
      "city": "Test City",
      "line1": "123 Main Street",
      "zipCode": "12345"
    },
    "paymentMethod": {
      "type": "BANK_DEPOSIT",
      "countryCode": "MEX",
      "accountNumberType": "DIMO",
      "bankCode": "012",
      "accountNumber": "5512345678"
    }
  },
  "additionalData": {}
}

What's Next

  • Country coverage — Every corridor's requirements in one table
  • Payout methods — Field reference per payout type
  • Errors — What PAY_001 means when a valid payload is rejected
PreviousAfricaNextAsia & Oceania