Retrieve posting accounts

Retrieve Posting Accounts

Request the details of Posting Accounts

The Retrieve Posting Accounts endpoint /offering/account_types enables you to retrieve the bank account types required to be sent in the boarding request.

This call is only required where you have configured more than one posting/settlement option in your acquiring offer.

Query parametersTypeDescriptionExampleMandatory / Optional / Conditional
acquiring_offering_external_idstringAn Acquiring Offer ID retrieved in the List offersEQ146-12368-91852-66F6E-AEA69-40D7D-6C845M
alliancestringThe Alliance CodeALL001M
posting_tariff_idstringAn unique ID assighent to the posting tariff194M

Example request:

?alliance=ALL001acquiring_offering_external_id=AC1CD-7F2F1-F8B14-E0F53-E7CF2-F09A1-746AD&posting_tariff_id=194

Receive the response with the details of Posting Accounts

The response contains the following fields:

FieldTypeDescription
resultstringEnumerations: SUCCESS / ERROR
operationstringEchoed from the request message
posting_tariffobjectContains id and the ID of the linked Acquiring(Processing) offer
posting_tariff_idstringID of the posting
acquiring_offering_external_idstringID of the linked Acquiring(Processing) offer
settlement_methodsarrayList of available settlement methods for the requested posting account
settlement_method_idstringAn ID assigned to the settlement method
settlement_method_namestringA name assigned to the settlement method
settlement_currenciesarrayCurrencies available for the settlement method
posting_accountsarrayList of available combination of different account types and settlement methods. For each combination a settlement_method_id, settlement_method_name and settlement_currency along with accounts (described below) is listed
accountsarrayList of available and required accounts type for the posting_accounts combination
account_type_idstringAn ID of the account type. List of available account type to be used with the offering is agreed with the alliance before the OMS system setup and configuration is done in order to meet the needs of the respective alliance
account_typestringName describing the account type
account_type_setup_external_idstringAn unique ID assigned to the account type

Example response messsage:

{
  "result":"SUCCESS",
  "operation":{
     "operation_type":"RETRIEVE_ACCOUNT_TYPES"
  },
  "posting_tariff":{
     "posting_tariff_id":"194",
     "acquiring_offering_external_id":"AC1CD-7F2F1-F8B14-E0F53-E7CF2-F09A1-746AD"
  },
  "settlement_methods":[
     {
        "settlement_method_id":"230",
        "settlement_method_name":"UK GBP",
        "settlement_currencies":[
           "GBP"
        ]
     }
  ],
  "posting_accounts":[
     {
        "settlement_method_id":"230",
        "settlement_method_name":"UK GBP",
        "settlement_currency":"GBP",
        "accounts":[
           {
              "account_type_id":"007",
              "account_type":"Fee Collect account",
              "account_type_setup_external_id":"ATS09-E1358-42D25-7FB72-8CB9E-C3D80-14534"
           },
           {
              "account_type_id":"009",
              "account_type":"Fee Hold Account",
              "account_type_setup_external_id":"ATSA3-A628A-FBF45-B7937-B0AA9-60470-AC12A"
           },
           {
              "account_type_id":"170",
              "account_type":"Paymnt Acct Retail",
              "account_type_setup_external_id":"ATSA1-9820B-9FDF6-32C5A-CD788-6DCF9-F643F"
           },
           {
              "account_type_id":"007",
              "account_type":"Fee Collect account",
              "account_type_setup_external_id":"ATS17-1F712-3BD0D-EE9BD-D349A-77F25-C8992"
           },
           {
              "account_type_id":"009",
              "account_type":"Fee Hold Account",
              "account_type_setup_external_id":"ATSC7-FDF6E-31C40-EBEBF-4279C-FA10B-A2F74"
           }
        ]
     }
  ]
}

Did this page help you?