DocsRecipesAPI Rest
DocsAPI RestRecipesTutorialsHelpLog In
Docs
DocsAPI RestRecipesTutorialsHelp

Accounts Fees

Caribbean
Colombia
Mexico

These set of endpoints are used to retrieve information about the Omnipay´s Account´s Fees configuration available for the institution.

The information can be accessed in two ways: using a single method that returns all accounts available, without filter or using filters to retrieve specific accounts.

Method: GET /api/v1/application/account-fees

This endpoint is used to retrieve information about all the Account Fee´s configuration on Omnipay for the institution.

  1. Parameters
    a. No parameters
  2. Responses
    a. “200” – OK. Indicates success in the inquiry and provides a list of all Omnipay´s Account Fees parameters available for the institution. The list provided should be filtered according to the parameters such as: Client Tarif, Account Type, currency Code, Trigger Source, Fee Type. Those filters will point to a specific recordId field value, that should be informed in the boarding / maintenance payload, section main.accounts.
    b. “204” - No register found
    c. “400” - Bad request
    d. “401” - Unauthorized request
    e. “403” - Forbidden request
    f. “500” - Internal Error
    g. “502” - API Error

Method: GET /api/v1/application/account-type

This endpoint is used to retrieve information about all the Account Types configuration on Omnipay for the institution.

  1. Parameters
    a. No parameters
  2. Responses
    a. “200” – OK. Indicates success in the inquiry and provides a list of all Omnipay´s Account Type´s parameters available for the institution, that can be used as parameter for method get /account-record.
    b. “204” - No register found
    c. “400” - Bad request
    d. “401” - Unauthorized request
    e. “403” - Forbidden request
    f. “500” - Internal Error
    g. “502” - API Error

Method: GET /api/v1/application/account-currency

This endpoint is used to retrieve information about all the Account Currency configuration on Omnipay for the institution.

  1. Parameters
    a. No parameters
  2. Responses
    a. “200” – OK. Indicates success in the inquiry and provides a list of all Omnipay´s Account currency´s parameters available for the institution, that can be used as parameter for method get /account-record.
    b. “204” - No register found
    c. “400” - Bad request
    d. “401” - Unauthorized request
    e. “403” - Forbidden request
    f. “500” - Internal Error
    g. “502” - API Error

Method: GET /api/v1/application/account-record

This endpoint is used to retrieve information about the Account Fee´s configuration on Omnipay for the institution, filtered by the parameters informed.

  1. Parameters
    a. AccountType – Account Type Index
    b. AccountCurrency – Account currency code
  2. Responses
    a. “200” - OK
    Indicates success in the inquiry and provides a list of all Omnipay´s Account Fees parameters available for the institution, filtered by the parameters.
    The list provided should be filtered according to the parameters such as: Client Tarif, Trigger Source, Fee Type. Those filters will point to a specific recordId field value, that should be informed in the boarding / maintenance payload, section main.accounts.
    b. “204” - No register found
    c. “400” - Bad request
    d. “401” - Unauthorized request
    e. “403” - Forbidden request
    f. “500” - Internal Error
    g. “502” - API Error

Method: GET /api/v1/application/account-settlements

This endpoint is used to retrieve information about the Settlement´s configuration on Omnipay for the institution.

  1. Parameters
    a. No parameter
  2. Responses
    a. “200” – OK. Indicates success in the inquiry and provides a list of all Omnipay´s Settlements parameters available for the institution, that can be used into the boarding / maintenance payload.