Payees (Beneficiaries)

Overview

The Payees module is an integral part of the customer API that allows users to manage their list of payees—people or organizations they need to send money to. It provides a suite of API endpoints that facilitate various operations required to maintain an up-to-date payee list for customers within the platform.

1. Create Payee - Allows users to add a new payee with details such as name, banking information, and address. This is essential for setting up new beneficiaries for transactions.

2. Edit Payee - Users can update the details of an existing payee. This endpoint is useful for making corrections or changes to the payee information, such as their bank account details or address.

3. Get Payee by ID - Enables a user to retrieve information about a payee by submitting the ID of the payee.

4. List Payees - Retrieve a list of payees associated with a customer

5. Delete Payee - Allows a user to delete a Payee, removing it from being an option for further transfer destinations

6. Create Card Payee - Allows a user to create a new payee for use with Visa Direct.

7. View Card Payee - Allows a user view details for a card payee.

8. List Card Payees - Retrieves a list of available card payees.

9. Initiate ACH Pull - Allows a manager to initiate an ACH pull request from a customer's payee. If used with a card payee, will initiate a Visa Direct pull instead.

---

Create Payee

This endpoint creates a new payee for a specific customer. A payee is essentially a destination that where one would send a payment to outside of the banking system, such as a bank account. A customer can use this feature to add a new person or company they need to send money to. The customer inputs necessary banking details and address information to set up the payee in their account

• Endpoint: /api/v3/customer/payees/create

• Method: POST

Create a payee for a customer

Request body:

• CustomersId: customers Id
• CustomerAssetAccountsID: Customer's asset account id
• PayeeType: Payee type (Personal, Company)
• RoutingNumber: Payee's routing number (required for domestic payees)
• AccountNumber: Payee's account number (required)
• Bic: Payee's BIC number (required for international payees)
• IntermediaryBic: Payee's intermediary BIC number (optional)
• Iban: Payee's IBAN number (required for international payees)
• PayeesReference: Customer payee reference
• Name: Payee's name
• AddressLine1: Payee's address line 1
• AddressLine2: Payee's address line 2 (optional)
• TownCity: Payee's town or city
• State: Payee's state (optional)
• Postcode: Payee's postcode
• Country: Payee's country code (required for international payees)
• Transmitter: Details of transmitter (required for financial institutions)
• Transmitter.FirstPartyTransfer: Is this payee for first party transfers
• Transmitter.Name: Transmitter name (required if not a first party transfer)
• Transmitter.AccountNumber: Transmitter account number (optional)
• Transmitter.AddressLine1: Transmitter address line 1 (required if not a first party transfer)
• Transmitter.AddressLine2: Transmitter address line 2 (optional)
• Transmitter.TownCity: Transmitter town or city (required if not a first party transfer)
• Transmitter.State: Transmitter state (required if not a first party transfer)
• Transmitter.Postcode: Transmitter postcode (required if not a first party transfer)
• Transmitter.CountryCode: Transmitter country code (required if not a first party transfer)
• Transmitter.Type: Transmitter type - 'Individual' or 'Company'
• Transmitter.DateOfBirth: Transmitter date of birth (required if type is 'Individual')

Response:

• Id: Payee's Id
• CustomersId: Customer's Id
• PayeeType: Payee type
• PayeesReference: Customer defined payee reference
• RoutingNumber: Payee's routing number
• AccountNumber: Payee's account number
• Bic: Payee's BIC number
• IntermediaryBic : Payee's intermediary BIC number
• Iban: Payee's IBAN number
• Name: Payee's name
• AddressLine1: Payee address line 1
• AddressLine2: Payee address line 2
• TownCity: Payee's town or city
• State: Payee's state
• Postcode: Payee's postcode
• Country: Payee's country
• Transmitter: Details of transmitter (required for financial institutions)
• TransmitterFirstPartyTransfer: Is this payee for first party transfers
• TransmitterName: Transmitter name
• TransmitterAccountNumber: Transmitter account number
• TransmitterAddressLine1: Transmitter address line 1
• TransmitterAddressLine2: Transmitter address line 2
• TransmitterTownCity: Transmitter town or city
• TransmitterState: Transmitter state
• TransmitterPostcode: Transmitter postcode
• TransmitterCountryCode: Transmitter country code
• Transmitter.Type: Transmitter type
• Transmitter.DateOfBirth: Transmitter date of birth Possible validation errors:
• Required
• Invalid
• Already_Exists (Payee with specified account and routing number already exists)
• Only_One_Of_Bic_Or_RoutingNumber_Can_Be_Set
• Bic_Or_Country_Invalid

POST/api/v3/customer/payees/create

Header parameters

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

transmitterCustomerRole.General.TransmitterRequestDto (object)

customersIdnullable integer (int32)

customerAssetAccountsIDinteger (int32)

payeeTypePayeeTypes (enum)

PersonalCompany

routingNumbernullable string

accountNumbernullable string

bicnullable string

intermediaryBicnullable string

ibannullable string

payeesReferencenullable string

namenullable string

addressLine1nullable string

addressLine2nullable string

addressCountryCodenullable string

townCitynullable string

statenullable string

postcodenullable string

countrynullable string

bankNamenullable string

currencyCodenullable string

Response

200400

OK

Body

application/json

idinteger (int64)

detailsCustomerRole.PayeesV3.PayeeDto (object)

statusnullable string

errorsnullable array of Results.Base.ErrorResultDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/customer/payees/create', {
    method: 'POST',
    headers: {
      "otp": "text",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "details": {
    "payeeType": "Personal",
    "payeesReference": "text",
    "routingNumber": "text",
    "accountNumber": "text",
    "bic": "text",
    "intermediaryBic": "text",
    "iban": "text",
    "name": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "townCity": "text",
    "state": "text",
    "postcode": "text",
    "country": "text",
    "bankName": "text",
    "transmitterFirstPartyTransfer": false,
    "transmitterName": "text",
    "transmitterAccountNumber": "text",
    "transmitterAddressLine1": "text",
    "transmitterAddressLine2": "text",
    "transmitterTownCity": "text",
    "transmitterState": "text",
    "transmitterPostcode": "text",
    "transmitterCountryCode": "text",
    "transmitterType": "text",
    "transmitterDateOfBirth": "text"
  },
  "status": "text",
  "errors": [
    {
      "fieldName": "text",
      "messageCode": "text"
    }
  ]
}

Request Body: application/json

• CustomersId (Integer, Required): The identifier for the customer.

• CustomerAssetAccountsId (Integer, Required): Customer's account from which funds will be sent.

• PayeeType (String, Required): The type of payee, values can be Personal or Company.

• RoutingNumber (String, Optional, For domestic payees): The routing number of the payee's bank for domestic transactions.

• AccountNumber (String, Required): The bank account number of the payee.

• BankName (String, Optional): The bank's name. This will be looked up based on other information if not included.

• Bic (String, Optional, For international payees): The SWIFT/BIC code for international banking purposes.

• IntermediaryBic (String, Optional, For international payees): Bank intermediary SWIFT/BIC code.

• Iban (String, Optional, For international payees): The International Bank Account Number for international transactions.

• PayeesReference (String, Optional): A customer-defined reference for the payee.

• Name (String, Required): The full name of the payee.

• AddressLine1 (String, Required): The primary address line for the payee.

• AddressLine2 (String, Optional): The secondary address line for the payee (if any).

• TownCity (String, Required): The town or city where the payee is located.

• State (String, Required): The state or region where the payee is located.

• Country (String, Required): The country where the payee is located.

• Postcode (String, Required): The postal code associated with the payee's address.

• Transmitter (Object, Optional): Transmitter information, required for financial institutions.

• Transmitter.FirstPartyTransfer (Boolean, Required): Is this payee for first party transfers?

• Transmitter.Name (String, Required if not a first party transfer): Transmitter's name.

• Transmitter.AccountNumber (String, Optional): Transmitter's account number.

• Transmitter.AddressLine1 (String, Required if not a first party transfer): Transmitter's address line 1.

• Transmitter.AddressLine2 (String, Optional): Transmitter's address line 2.

• Transmitter.TownCity (String, Required if not a first party transfer): Transmitter's town or city.

• Transmitter.State (String, Required if not a first party transfer): Transmitter's state. For USA use the ANSI 2-letter state codes.

• Transmitter.Postcode (String, Required if not a first party transfer): Transmitter's postcode.

• Transmitter.CountryCode (String, Required if not a first party transfer): Transmitter's alpha-3 country code.

• Transmitter.Type (String, Required if not a first party transfer): Transmitter's type, either 'Individual' or 'Company'.

• Transmitter.DateOfBirth (String, Required if type is 'Individual', ISO 8061): The transmitter's date of birth in "YYYY-MM-DD" format.

Request Body Example:

{
    	"CustomersId":1545,
        "CustomerAssetAccountsId":3684,
        "PayeeType":"Personal",
        "AccountNumber":"12345678922",
        "RoutingNumber":null,
        "bic":"NAIAGB23",
        "IntermediaryBic":"XXXX",
        "iban":"Foo",
        "PayeesReference":"MYPAYEE123",
	"Name":"My Payee",
	"AddressLine1":"Line1",
	"AddressLine2":"Line2",
	"TownCity":"MyCity",
	"State":"Essex",
	"Postcode":"MK1 9AJ",
        "Country":"GBR",
        "Transmitter":{
            "FirstPartyTransfer": true,
            "Name": "John Doe",
            "AccountNumber": "123456789",
            "AddressLine1": "123 Main St",
            "AddressLine2": "Apt 4B",
            "TownCity": "New York",
            "State": "NY",
            "Postcode": "10001",
            "CountryCode": "USA",
            "Type": "Individual",
            "DateOfBirth": "1988-04-21"
        }
}

Response Body (Success): application/json

• id (Integer): A generated ID that references the newly created payee.

• details (Object): An object containing details about the newly created payee:

  • id (Integer): Same as the outer id field for ease of access.

  • customersId (Integer): The customer's ID for whom the payee was created.

  • customerAssetAccountsId (Integer): Customer's account from which funds will be sent. to payee.

  • payeeType (String): The type of payee, Personal or Company.

  • payeeReference (String): Customer defined payee reference.

  • routingNumber (String): The routing number of the payee's bank.

  • accountNumber (String): The bank account number of the payee.

  • bic (String): The SWIFT/BIC code of the payee.

  • IntermediaryBic (String): Payee's intermediary BIC number

  • iban (String): The International Bank Account Number of the payee.

  • name (String): The full name of the payee.

  • addressLine1 (String): The primary address line for the payee.

  • addressLine2 (String): The secondary address line for the payee.

  • townCity (String): The town or city where the payee is located.

  • state (String): The state or region where the payee is located.

  • postcode (String): The postal code for the payee's address.

  • country (String): The country where the payee is located.

  • bankName (String): The name of the payee's bank.

  • transmitterFirstPartyTransfer (Boolean): Is this payee for first party transfers?

  • transmitterName (String): Transmitter's name.

  • transmitterAccountNumber (String): Transmitter's account number.

  • transmitterAddressLine1 (String): Transmitter's address line 1.

  • transmitterAddressLine2 (String): Transmitter's address line 2.

  • transmitterTownCity (String): Transmitter's town or city.

  • transmitterState (String): Transmitter's state.

  • transmitterPostcode (String): Transmitter's postcode.

  • transmitterCountryCode (String): Transmitter's alpha-3 country code.

  • transmitterType (String): Transmitter's type, either 'Individual' or 'Company'.

  • transmitterDateOfBirth (String, ISO 8061): The transmitter's date of birth in "YYYY-MM-DD" format.

• status (Integer): The status code, typically "1" for success.

• errors (Array): An array containing any error messages related to the request.

Response Body Example:

{
    "id": 1732,
    "details": {
        "id": 1732,
        "customersId": 1545,
        "customerAssetAccountsId": 3684,
        "payeeType": "Personal",
        "payeesReference": "MYPAYEE123",
        "routingNumber": null,
        "accountNumber": "12345678922",
        "bic": "NAIAGB23",
        "IntermediaryBic":"XXXX",
        "iban": "Foo",
        "name": "My Payee",
        "addressLine1": "Line1",
        "addressLine2": "Line2",
        "townCity": "MyCity",
        "state": "Essex",
        "postcode": "MK1 9AJ",
        "country": "GBR",
        "bankName": "",
        "transmitterFirstPartyTransfer": true,
        "transmitterName": "John Doe",
        "transmitterAccountNumber": "123456789",
        "transmitterAddressLine1": "123 Main St",
        "transmitterAddressLine2": "Apt 4B",
        "transmitterTownCity": "New York",
        "transmitterState": "NY",
        "transmitterPostcode": "10001",
        "transmitterCountryCode": "USA"
        "transmitterType": "Individual",
        "transmitterDateOfBirth": "1988-04-21"
    },
    "status": "1",
    "errors": []
}

Possible Error Response:

• Required (Error Code): Indicates that a required field is missing or has a zero value.

• Invalid (Error Code): Suggests that a field contains an invalid value.

• Documents_Not_Verified (Error Code): This action cannot be performed for the customer due to KYC (Know Your Customer) requirements not being met.

---

Edit Payee

Users can update the details of someone they've set up to send payments to (a payee). They'll need to provide specific information like the account details they wish to change. Once submitted, the system updates the payee's details, confirming the updates with the user or reporting why it wasn't able to if there's an issue. Only non-null fields will be updated. This endpoint cannot be used to edit card payees.

• Endpoint: /api/v3/customer/payees/edit

• Method: PATCH

Edit payee

Request body:

• CustomersId: customers Id
• PayeeType: Payee type (Personal, Company) (optional)
• RoutingNumber: Payee's routing number (optional)
• AccountNumber: Payee's account number (optional)
• Bic: Payee's BIC number (optional)
• IntermediaryBic: Payee's intermediary BIC number (optional)
• Iban: Payee's IBAN number (optional)
• PayeesReference: Customer payee reference (optional)
• Name: Payee's name (optional)
• AddressLine1: Payee's address line 1 (optional)
• AddressLine2: Payee's address line 2 (optional)
• TownCity: Payee's town or city (optional)
• State: Payee's state (optional)
• Postcode: Payee's postcode (optional)
• Transmitter: Details of transmitter (required for financial institutions)
• Transmitter.FirstPartyTransfer: Is this payee for first party transfers
• Transmitter.Name: Transmitter name (required if not a first party transfer)
• Transmitter.AccountNumber: Transmitter account number (optional)
• Transmitter.AddressLine1: Transmitter address line 1 (required if not a first party transfer)
• Transmitter.AddressLine2: Transmitter address line 2 (optional)
• Transmitter.TownCity: Transmitter town or city (required if not a first party transfer)
• Transmitter.State: Transmitter state (required if not a first party transfer)
• Transmitter.Postcode: Transmitter postcode (required if not a first party transfer)
• Transmitter.CountryCode: Transmitter country code (required if not a first party transfer)
• Transmitter.Type: Transmitter type - 'Individual' or 'Company'
• Transmitter.DateOfBirth: Transmitter date of birth (required if type is 'Individual')

Response:

• Id: Payee's Id
• CustomersId: Customer's Id
• CustomerAssetAccountsID: Customer's asset account id
• PayeeType: Payee type
• PayeesReference: Customer defined payee reference
• RoutingNumber: Payee's routing number
• AccountNumber: Payee's account number
• Bic: Payee's BIC number
• IntermediaryBic : Payee's intermediary BIC number
• Iban: Payee's IBAN number
• Name: Payee's name
• AddressLine1: Payee address line 1
• AddressLine2: Payee address line 2
• TownCity: Payee's town or city
• State: Payee's state
• Postcode: Payee's postcode
• Country: Payee's country
• Transmitter: Details of transmitter (required for financial institutions)
• TransmitterFirstPartyTransfer: Is this payee for first party transfers
• TransmitterName: Transmitter name
• TransmitterAccountNumber: Transmitter account number
• TransmitterAddressLine1: Transmitter address line 1
• TransmitterAddressLine2: Transmitter address line 2
• TransmitterTownCity: Transmitter town or city
• TransmitterState: Transmitter state
• TransmitterPostcode: Transmitter postcode
• TransmitterCountryCode: Transmitter country code
• Transmitter.Type: Transmitter type
• Transmitter.DateOfBirth: Transmitter date of birth

Possible validation errors:

• Required
• Invalid
• Already_Exists (Payee with specified account and routing number already exists)
• Only_One_Of_Bic_Or_RoutingNumber_Can_Be_Set
• Bic_Or_Country_Invalid

PATCH/api/v3/customer/payees/edit

Header parameters

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

transmitterCustomerRole.General.TransmitterRequestDto (object)

idnullable integer (int32)

payeeTypePayeeTypes (enum)

PersonalCompany

routingNumbernullable string

accountNumbernullable string

bicnullable string

intermediaryBicnullable string

ibannullable string

payeesReferencenullable string

namenullable string

addressLine1nullable string

addressLine2nullable string

addressCountryCodenullable string

townCitynullable string

statenullable string

countrynullable string

postcodenullable string

bankNamenullable string

Response

200400

OK

Body

application/json

idinteger (int64)

detailsCustomerRole.PayeesV3.PayeeDto (object)

statusnullable string

errorsnullable array of Results.Base.ErrorResultDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/customer/payees/edit', {
    method: 'PATCH',
    headers: {
      "otp": "text",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "details": {
    "payeeType": "Personal",
    "payeesReference": "text",
    "routingNumber": "text",
    "accountNumber": "text",
    "bic": "text",
    "intermediaryBic": "text",
    "iban": "text",
    "name": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "townCity": "text",
    "state": "text",
    "postcode": "text",
    "country": "text",
    "bankName": "text",
    "transmitterFirstPartyTransfer": false,
    "transmitterName": "text",
    "transmitterAccountNumber": "text",
    "transmitterAddressLine1": "text",
    "transmitterAddressLine2": "text",
    "transmitterTownCity": "text",
    "transmitterState": "text",
    "transmitterPostcode": "text",
    "transmitterCountryCode": "text",
    "transmitterType": "text",
    "transmitterDateOfBirth": "text"
  },
  "status": "text",
  "errors": [
    {
      "fieldName": "text",
      "messageCode": "text"
    }
  ]
}

Request Body Parameters: application/json

Only non-null fields will be updated!

• Id (Integer, Required): The ID of the payee to be edited.

• PayeeType (String, Optional): The type of payee, values can be Personal or Company.

• RoutingNumber (String, Optional): The routing number of the payee's bank for domestic transactions.

• AccountNumber (String, Optional): The bank account number of the payee.

• BankName (String, Optional): The bank's name, which will be looked up based on other information if not included.

• Bic (String, Optional): The SWIFT/BIC code for international banking purposes.

• IntermediaryBic (String, Optional, For international payees): Bank intermediary SWIFT/BIC code

• Iban (String, Optional): The International Bank Account Number for international transactions.

• PayeesReference (String, Optional): A customer-defined reference for the payee.

• Name (String, Optional): The full name of the payee.

• AddressLine1 (String, Optional): The primary address line for the payee.

• AddressLine2 (String, Optional): The secondary address line for the payee (if any).

• TownCity (String, Optional): The town or city where the payee is located.

• State (String, Optional): The state or region where the payee is located.

• Country (String, Optional): The country where the payee is located.

• Postcode (String, Optional): The postal code associated with the payee's address.

• Transmitter (Object, Optional): Transmitter information, required for financial institutions.

• Transmitter.FirstPartyTransfer (Boolean, Required): Is this payee for first party transfers?

• Transmitter.Name (String, Required if not a first party transfer): Transmitter's name.

• Transmitter.AccountNumber (String, Optional): Transmitter's account number.

• Transmitter.AddressLine1 (String, Required if not a first party transfer): Transmitter's address line 1.

• Transmitter.AddressLine2 (String, Optional): Transmitter's address line 2.

• Transmitter.TownCity (String, Required if not a first party transfer): Transmitter's town or city.

• Transmitter.State (String, Required if not a first party transfer): Transmitter's state. For USA use the ANSI 2-letter state codes.

• Transmitter.Postcode (String, Required if not a first party transfer): Transmitter's postcode.

• Transmitter.CountryCode (String, Required if not a first party transfer): Transmitter's alpha-3 country code.

• Transmitter.Type (String, Required if not a first party transfer): Transmitter's type, either 'Individual' or 'Company'.

• Transmitter.DateOfBirth (String, Required if type is 'Individual', ISO 8061): The transmitter's date of birth in "YYYY-MM-DD" format.

Request Body Example:

{
    "id": 2288,
    "PayeeType": "Personal",
    "RoutingNumber": "",
    "AccountNumber": "521101580",
    "BankName": "My Bank",
    "Bic": "CZNBVN2XXXX",
    "IntermediaryBic":"XXXX",
    "Iban": "12345Test",
    "PayeesReference": "RefExample",
    "Name": "Name Surname",
    "AddressLine1": "Address Line 1",
    "TownCity": "Austin",
    "State": "TX",
    "Country": "VNM",
    "Postcode": "123ABC",
    "Transmitter":{
            "FirstPartyTransfer": true,
            "Name": "John Doe",
            "AccountNumber": "123456789",
            "AddressLine1": "123 Main St",
            "AddressLine2": "Apt 4B",
            "TownCity": "New York",
            "State": "NY",
            "Postcode": "10001",
            "CountryCode": "USA",
            "Type": "Individual",
            "DateOfBirth": "1988-04-21"
    }
}

Response Body Parameters: application/json

• id (Integer): A reference ID for the payee; not used in the example.

• details (Object): An object containing updated details about the payee, including:

  • id (Integer): The ID of the payee that was edited.

  • customersId (Integer): The customer's ID associated with the edited payee.

  • customerAssetAccountsId (Integer): Customer's account from which funds will be sent. to payee.

  • payeeType (String): The updated type of payee, Personal or Company.

  • payeesReference (String): The updated customer defined payee reference.

  • routingNumber (String): The updated routing number of the payee's bank.

  • accountNumber (String): The updated bank account number of the payee.

  • bic (String): The updated SWIFT/BIC code of the payee.

  • IntermediaryBic (String): Payee's intermediary BIC number

  • iban (String): The updated International Bank Account Number of the payee.

  • name (String): The updated name of the payee.

  • addressLine1 (String): The updated address line for the payee.

  • addressLine2 (String, Nullable): The updated address line 2 for the payee.

  • townCity (String): The updated town or city where the payee is located.

  • state (String): The updated state or region where the payee is located.

  • postcode (String): The updated postal code for the payee's address.

  • country (String): The updated country where the payee is located.

  • bankName (String): The updated bank name of the payee.

  • transmitterFirstPartyTransfer (Boolean): Is this payee for first party transfers?

  • transmitterName (String): Transmitter's name.

  • transmitterAccountNumber (String): Transmitter's account number.

  • transmitterAddressLine1 (String): Transmitter's address line 1.

  • transmitterAddressLine2 (String): Transmitter's address line 2.

  • transmitterTownCity (String): Transmitter's town or city.

  • transmitterState (String): Transmitter's state.

  • transmitterPostcode (String): Transmitter's postcode.

  • transmitterCountryCode (String): Transmitter's alpha-3 country code.

  • transmitterType (String): Transmitter's type, either 'Individual' or 'Company'.

  • transmitterDateOfBirth (String, ISO 8061): The transmitter's date of birth in "YYYY-MM-DD" format.

Success Response Example:

{
    "id": 2288,
    "details": {
        "id": 2288,
        "customersId": 1545,
        "customerAssetAccountsId": 1707,
        "payeeType": "Personal",
        "payeesReference": "RefExample",
        "routingNumber": null,
        "accountNumber": "521101580",
        "bic": "CZNBVN2XXXX",
        "intermediaryBic": "XXXX",
        "iban": "12345Test",
        "name": "Name Surname",
        "addressLine1": "Address Line 1",
        "addressLine2": "Line2",
        "townCity": "Austin",
        "state": "TX",
        "postcode": "123ABC",
        "country": "VNM",
        "bankName": "My Bank",
        "transmitterFirstPartyTransfer": true,
        "transmitterName": "John Doe",
        "transmitterAccountNumber": "123456789",
        "transmitterAddressLine1": "123 Main St",
        "transmitterAddressLine2": "Apt 4B",
        "transmitterTownCity": "New York",
        "transmitterState": "NY",
        "transmitterPostcode": "10001",
        "transmitterCountryCode": "USA",
        "transmitterType": "Individual",
        "transmitterDateOfBirth": "1988-04-21"
    },
    "status": "1",
    "errors": []
}

Error Codes:

• Required (Error Code): Indicates that a required field is missing or has a zero value.

• Invalid (Error Code): Suggests that a field contains an invalid value.

• Documents_Not_Verified (Error Code): The action cannot be performed for the customer due to KYC (Know Your Customer) requirements not being met.

Error Response Example:

{
  "id": 0,
  "details": null,
  "status": "0",
  "errors": [
    {
      "errorType": "BadRequest",
      "fieldName": "PayeeType",
      "messageCode": "Invalid"
    }
  ]
}

---

Get Payee by ID

Users can retrieve the details of someone they've set up to send payments to (a payee). They'll need to provide the specific ID of the payee to retrieve information. This endpoint should not be used for card payees, use the card view endpoint instead.

• Endpoint: /api/v3/customer/payees/get

• Method: GET

Get payee by Id

Request query:

• Id: Payee's Id

Response:

• Id: Payee's Id
• CustomersId: Customer's Id
• CustomerAssetAccountsID: Customer's asset account id
• PayeeType: Payee type
• PayeesReference: Customer defined payee reference
• RoutingNumber: Payee's routing number
• AccountNumber: Payee's account number
• Bic: Payee's BIC number
• IntermediaryBic : Payee's intermediary BIC number
• Iban: Payee's IBAN number
• Name: Payee's name
• AddressLine1: Payee address line 1
• AddressLine2: Payee address line 2
• TownCity: Payee's town or city
• State: Payee's state
• Postcode: Payee's postcode
• Country: Payee's country
• TransmitterFirstPartyTransfer: Is this payee for first party transfers
• TransmitterName: Transmitter name
• TransmitterAccountNumber: Transmitter account number
• TransmitterAddressLine1: Transmitter address line 1
• TransmitterAddressLine2: Transmitter address line 2
• TransmitterTownCity: Transmitter town or city
• TransmitterState: Transmitter state
• TransmitterPostcode: Transmitter postcode
• TransmitterCountryCode: Transmitter country code
• Transmitter.Type: Transmitter type
• Transmitter.DateOfBirth: Transmitter date of birth

Possible validation errors:

• Required,
• Invalid

GET/api/v3/customer/payees/get

Query parameters

Header parameters

Response

200400

OK

Body

application/json

idinteger (int64)

detailsCustomerRole.PayeesV3.PayeeDto (object)

statusnullable string

errorsnullable array of Results.Base.ErrorResultDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/customer/payees/get', {
    method: 'GET',
    headers: {
      "otp": "text"
    },
});
const data = await response.json();

Response

200400

{
  "details": {
    "payeeType": "Personal",
    "payeesReference": "text",
    "routingNumber": "text",
    "accountNumber": "text",
    "bic": "text",
    "intermediaryBic": "text",
    "iban": "text",
    "name": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "townCity": "text",
    "state": "text",
    "postcode": "text",
    "country": "text",
    "bankName": "text",
    "transmitterFirstPartyTransfer": false,
    "transmitterName": "text",
    "transmitterAccountNumber": "text",
    "transmitterAddressLine1": "text",
    "transmitterAddressLine2": "text",
    "transmitterTownCity": "text",
    "transmitterState": "text",
    "transmitterPostcode": "text",
    "transmitterCountryCode": "text",
    "transmitterType": "text",
    "transmitterDateOfBirth": "text"
  },
  "status": "text",
  "errors": [
    {
      "fieldName": "text",
      "messageCode": "text"
    }
  ]
}

---

List Payees

Retrieve a list of payees associated with a customer. Card payees will not be present in this list and have their own list endpoint.

• Endpoint: /api/v3/customer/payees/list

• Method: GET

List all payees

Request query:

• CustomersId: Customer Id filter
• CustomerAssetAccountsID: Customer's asset account id
• PayeesReference: Payee reference filter
• RoutingNumber: routing number filter
• AccountNumber: account number filter
• Bic: BIC number filter
• Iban: IBAN number filter
• Country: Country code filter
• PageNumber: list page number (optional, default = 1)
• PageSize: list page size (optional, default = 10)

Response:

• array of
  • Id: Payee's Id
  • CustomersId: Customer's Id
  • PayeeType: Payee type
  • PayeesReference: Customer defined payee reference
  • RoutingNumber: Payee's routing number
  • AccountNumber: Payee's account number
  • Bic: Payee's BIC number
  • IntermediaryBic : Payee's intermediary BIC number
  • Iban: Payee's IBAN number
  • Name: Payee's name
  • AddressLine1: Payee address line 1
  • AddressLine2: Payee address line 2
  • TownCity: Payee's town or city
  • State: Payee's state
  • Postcode: Payee's postcode
  • Country: Payee's country
  • TransmitterFirstPartyTransfer: Is this payee for first party transfers
  • TransmitterName: Transmitter name
  • TransmitterAccountNumber: Transmitter account number
  • TransmitterAddressLine1: Transmitter address line 1
  • TransmitterAddressLine2: Transmitter address line 2
  • TransmitterTownCity: Transmitter town or city
  • TransmitterState: Transmitter state
  • TransmitterPostcode: Transmitter postcode
  • TransmitterCountryCode: Transmitter country code
  • Transmitter.Type: Transmitter type
  • Transmitter.DateOfBirth: Transmitter date of birth

GET/api/v3/customer/payees/list

Query parameters

Header parameters

Response

200400

OK

Body

application/json

idinteger (int64)

detailsnullable array of CustomerRole.PayeesV3.PayeeDto (object)

pageSizenullable integer (int32)

pageNumbernullable integer (int32)

numberOfPagesnullable integer (int32)

statusnullable string

errorsnullable array of Results.Base.ErrorResultDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/customer/payees/list', {
    method: 'GET',
    headers: {
      "otp": "text"
    },
});
const data = await response.json();

Response

200400

{
  "details": [
    {
      "payeeType": "Personal",
      "payeesReference": "text",
      "routingNumber": "text",
      "accountNumber": "text",
      "bic": "text",
      "intermediaryBic": "text",
      "iban": "text",
      "name": "text",
      "addressLine1": "text",
      "addressLine2": "text",
      "townCity": "text",
      "state": "text",
      "postcode": "text",
      "country": "text",
      "bankName": "text",
      "transmitterFirstPartyTransfer": false,
      "transmitterName": "text",
      "transmitterAccountNumber": "text",
      "transmitterAddressLine1": "text",
      "transmitterAddressLine2": "text",
      "transmitterTownCity": "text",
      "transmitterState": "text",
      "transmitterPostcode": "text",
      "transmitterCountryCode": "text",
      "transmitterType": "text",
      "transmitterDateOfBirth": "text"
    }
  ],
  "status": "text",
  "errors": [
    {
      "fieldName": "text",
      "messageCode": "text"
    }
  ]
}

---

Delete Payee

Allows a user to delete a Payee, removing it from being an option for further transfer destinations. This endpoint is also used to delete card payees.

• Endpoint: /api/v1/customer/payees/delete

• Method: DELETE

Delete payee

Request body:

• Id: Payee's Id

Possible validation errors:

• Required,
• Invalid

DELETEhttp://public-api.ibanera.com/api/v1/customer/payees/delete

Header parameters

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

idnullable integer (int32)

Response

200400

Success

Body

application/json

statusnullable string

errorsnullable array of AvamaeTemplate.Core.Types.Results.Base.ErrorResultDto (object)

idinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('http://public-api.ibanera.com/api/v1/customer/payees/delete', {
    method: 'DELETE',
    headers: {
      "otp": "text",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "status": "text",
  "errors": [
    {
      "fieldName": "text",
      "messageCode": "text"
    }
  ]
}

---

Create Card Payee

Add a card (Visa Direct) payee using card details.

• Endpoint: /api/v1/customer/payees/card/create

• Method: POST

Create a card (Visa direct) payee for a customer

Request body:

Response:

• Id: Payee's Id

Possible validation errors:

• Required
• Invalid

POST/api/v1/customer/payees/card/create

Header parameters

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

customersId*integer (int32)

customerAssetAccountsId*integer (int32)

countryCode*CountryIso3Codes (enum)

AFGALBATADZAASMANDAGOATGAZEARGAUSAUTBHSBHRBGDARMBRBBELBMUBTNBOLBIHBWABVTBRABLZIOTSLBVGBBRNBGRMMRBDIBLRKHMCMRCANCPVCYMCAFLKATCDCHLCHNTWNCXRCCKCOLCOMMYTCOGCODCOKCRIHRVCUBCYPCZEBENDNKDMADOMECUSLVGNQETHERIESTFROFLKSGSFJIFINALAFRAGUFPYFATFDJIGABGEOGMBPSEDEUGHAGIBKIRGRCGRLGRDGLPGUMGTMGINGUYHTIHMDVATHNDHKGHUNISLINDIDNIRNIRQIRLISRITACIVJAMJPNKAZJORKENPRKKORKWTKGZLAOLBNLSOLVALBRLBYLIELTULUXMACMDGMWIMYSMDVMLIMLTMTQMRTMUSMEXMCOMNGMDAMNEMSRMARMOZOMNNAMNRUNPLNLDCUWABWSXMBESNCLVUTNZLNICNERNGANIUNFKNORMNPUMIFSMMHLPLWPAKPANPNGPRYPERPHLPCNPOLPRTGNBTLSPRIQATREUROURUSRWABLMSHNKNAAIALCAMAFSPMVCTSMRSTPSAUSENSRBSYCSLESGPSVKVNMSVNSOMZAFZWEESPSSDSDNESHSURSJMSWZSWECHESYRTJKTHATGOTKLTONTTOARETUNTURTKMTCATUVUGAUKRMKDEGYGBRGGYJEYIMNTZAUSAVIRBFAURYUZBVENWLFWSMYEMZMB

firstName*string

lastName*string

cardNumber*string

expirationDate*string (date-time)

cvv*string

Response

200400

OK

Body

application/json

idinteger (int32)

statusnullable string

errorsnullable array of Results.Base.ErrorResultDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/customer/payees/card/create', {
    method: 'POST',
    headers: {
      "otp": "text",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "cardNumber": "text",
      "countryCode": "AFG",
      "cvv": "text",
      "expirationDate": "2024-11-21T07:39:15.449Z",
      "firstName": "text",
      "lastName": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "status": "text",
  "errors": [
    {
      "fieldName": "text",
      "messageCode": "text"
    }
  ]
}

---

View Card Payee

View details for a card payee

• Endpoint: /api/v1/customer/payees/card/get

• Method: GET

View card payee details

GET/api/v1/customer/payees/card/get

Query parameters

Header parameters

Response

200400

OK

Body

application/json

idinteger (int64)

detailsCustomerRole.Payees.CardPayeeDto (object)

statusnullable string

errorsnullable array of Results.Base.ErrorResultDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/customer/payees/card/get', {
    method: 'GET',
    headers: {
      "otp": "text"
    },
});
const data = await response.json();

Response

200400

{
  "details": {
    "payeesReference": "text",
    "lastFourDigits": "text",
    "cardCompany": "text",
    "name": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "townCity": "text",
    "state": "text",
    "postcode": "text",
    "country": "text"
  },
  "status": "text",
  "errors": [
    {
      "fieldName": "text",
      "messageCode": "text"
    }
  ]
}

---

List Card Payees

List all available card payees

• Endpoint: /api/v1/customer/payees/card/list

• Method: GET

List card payees

GET/api/v1/customer/payees/card/list

Query parameters

Header parameters

Response

200400

OK

Body

application/json

idinteger (int64)

detailsnullable array of CustomerRole.Payees.CardPayeeDto (object)

pageSizenullable integer (int32)

pageNumbernullable integer (int32)

numberOfPagesnullable integer (int32)

statusnullable string

errorsnullable array of Results.Base.ErrorResultDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/customer/payees/card/list', {
    method: 'GET',
    headers: {
      "otp": "text"
    },
});
const data = await response.json();

Response

200400

{
  "details": [
    {
      "payeesReference": "text",
      "lastFourDigits": "text",
      "cardCompany": "text",
      "name": "text",
      "addressLine1": "text",
      "addressLine2": "text",
      "townCity": "text",
      "state": "text",
      "postcode": "text",
      "country": "text"
    }
  ],
  "status": "text",
  "errors": [
    {
      "fieldName": "text",
      "messageCode": "text"
    }
  ]
}

---

Initiate ACH Pull

Allows a manager to initiate an ACH pull request from a customer's payee. If used with a card payee, will instead pull using Visa Direct.

• Endpoint: /api/v1/customer/payees/pullfunds

• Method: POST

Pull funds from a Plaid payee.

Possible validation errors:

• Required
• Invalid
• Screening_Failed
• Funding_Already_Pending

POSThttp://public-api.ibanera.com/api/v1/customer/payees/pullfunds

Header parameters

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

payeesIdnullable integer (int32)

amountnullable number (double)

customerAssetAccountsIdnullable integer (int32)

referenceSetternullable string

referencenullable string

Response

200400

Success

Body

application/json

statusnullable string

errorsnullable array of AvamaeTemplate.Core.Types.Results.Base.ErrorResultDto (object)

idinteger (int64)

detailsAvamaeTemplate.Core.Types.Dtos.CustomerRole.Payees.SaveAchPullDto (object)

Request

JavaScriptCurlPython

const response = await fetch('http://public-api.ibanera.com/api/v1/customer/payees/pullfunds', {
    method: 'POST',
    headers: {
      "otp": "text",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "status": "text",
  "errors": [
    {
      "fieldName": "text",
      "messageCode": "text"
    }
  ],
  "details": {
    "amount": 0,
    "description": "text",
    "dateTime": "2024-11-21T07:39:15.449Z",
    "bPending": false,
    "bApproved": false
  }
}

Request Body Parameters: application/json

Request Body Paramerer	Format	Description	Required
PayeesId	Integer	PayeesId where the bank can pull funds from	Yes
Amount	Decimal	Amount to be pulled from payee	Yes
CustomerAssetAccountsId	Integer	The destination customer account id	Yes
Reference	String	For pooled account this should be the reference of the pooled account. Maximum 15 characters allowed	Yes

Request Body Example

{
        "PayeesId":1204,
        "Amount":100,
        "CustomerAssetAccountsId":2141,
        "Reference":"REF2141"
}

Response Body

Response Body Parameter	Format	Description
id	Integer	Transfer Id
details.
details.id	Integer	Transaction Id
details.accountsId	Integer	Transaction account Id
details.fromTransactionsId	Integer	Nullable linked from transaction Id
details.fromAccountsId	Integer	Nullable linked from account Id
details.toTransactionsId	Integer	Nullable linked to transaction Id
details.toAccountsId	Integer	Nullable linked to account Id
details.amount	Decimal	Transaction amount
details.description	String	Transaction description
details.dateTime	ISO 8601	Transaction date
details.bPending	Bool	Is transaction pending
details.bApproved	Bool	Is screening approved

Request Body Example

{
    "id": 22117,
    "details": {
        "id": 31605,
        "accountsId": 2141,
        "fromTransactionsId": null,
        "fromAccountsId": null,
        "toTransactionsId": null,
        "toAccountsId": null,
        "amount": 100.000000000000000000,
        "description": "Funding Ibanera USD Account",
        "dateTime": "2024-04-15T11:21:08.8533333+00:00",
        "bPending": true,
        "bApproved": true
    },
    "status": "1",
    "errors": []
}

Potential Error Codes

Error message code example	Description
Required	Required field not provided
Invalid	Provided destination account is invalid or provided payee id is invalid
Funding_Already_Pending	If there is already some pull funds are pending on the destination customer account, not allowed to do another pull to the account.
Invalid_Source_Account	Provided source account is invalid
Invalid_Asset	Asset associated with the account is not fiat currency or both account have different assets.
Ach_limit_exceed_5000	The requested amount is greater than the allowed ach limit
Invalid_Reference_For_FBO_Account	For pooled destination account, given reference should match with the destination account reference
Internal_Error	Any unknown error