![](\"https://run.pstmn.io/button.svg\")
Welcome to AFX Link, Ascendant's API
\n1. PAYMENT SOLUTIONS OVERVIEW
\nAFXLink provides REST APIs that allow developers to integrate Ascendant's global payment and foreign exchange capabilities directly into their applications and internal systems.
\nUsing the AFXLink API, you can build workflows to manage payees, retrieve FX quotes, submit payments, check account balances, validate payment information, and track transactions.
\nThis guide is intended for developers integrating their applications or systems with the AFXLink API.
\nAFXLink APIs use REST principles, and API responses are returned in JSON.
\nAFXLink provides separate Sandbox and Live environments so you can build and test your integration before moving to production.
\nTo get started:
\nObtain your Sandbox API credentials from your Ascendant account manager.
\nConfigure authentication using your API credentials.
\nUse the AFXLink Postman collection to explore and test API requests.
\nBuild and test your integration in the Sandbox environment.
\nWhen you are ready to move to production, contact your Ascendant account manager to obtain Live API credentials.
\nSandbox and Live environments use separate API credentials. Do not use Sandbox credentials in the Live environment.
\n2.1 Postman Guide
\nYou can use Postman to explore and test AFXLink REST APIs before integrating them into your application.
\nThe AFXLink Postman collection provides sample requests that you can customize and send to available API methods.
\nTo get started:
\nSign up for or log in to your Postman account on postman.com.
\nFork the AFXLink Postman collection into your workspace.
\nConfigure the collection with your Sandbox API credentials.
\nSend a request and review the API response.
\nSelect Run in Postman below to access the collection.
2.2 API KEY
\nYou can use AFXLink APIs in two modes:
\nSandbox
Use the Sandbox environment to develop and test your integration.
Live
Use the Live environment to process production transactions.
Each environment uses separate API credentials. Contact your Ascendant account manager to obtain the appropriate credentials.
\nAPI Authentication
All AFXLink APIs are authenticated using HTTP Basic Authentication . Basic auth requires the following:
[YOUR_KEY_ID]
[YOUR_KEY_SECRET]
Use an Authorization header for each request in the format:
\nAuthorization: Basic BASE64_TOKEN
BASE64_TOKEN is the Base64-encoded value of:
YOUR_KEY_ID:YOUR_KEY_SECRET
API keys security
It is essential to store your API keys safely. For the utmost security, follow the best practices listed below when integrating with AFXLink APIs.
While integrating AFXLink APIs with your application, ensure that:
\nThe API key secret is not included in version control (GitHub, Gitlab).
\nYou only provide access to the API secret to employees on a need-to-know basis.
\nYou store all secrets, such as the API secret and Org ID in a secure vault.
\nDo not share your API Key secret with anyone or on any public platforms. This can pose security threats for your AFXLink account.
\n2.3 API GATEWAY URL
\nThe URL to the API service is either:
\nSandbox. https://afxlink-staging.ascendantfx.com/
Live. https://afxlink-live.ascendantfx.com/
You need to include this before each API endpoint to make API calls.
\nYou can use the below endpoint to run a health check or ping on the AFXLink API.
If the web service is accessible, it will return its latest version with response status \"OK.\"
https://afxlink-staging.ascendantfx.com/api/getservice/status
\nAFXLink uses several core objects throughout its API requests, responses, and payment workflows.
\nUnderstanding these objects will make it easier to work with the API.
\n3.1 API Entities
\ni. Client
\nThe Client must be registered with Ascendant before using the API. Once registered, the Client receives an Organization ID and API credentials.
\nThe Client's application uses these credentials to authenticate API requests and access permitted AFXLink functionality.
\nii. Payee
\nA Payee is the recipient of the payment. A Payee record includes information such as:
\nPayee Information: Name, Mail id, Currency, Address, Account number etc
\nPayee Bank Information: Details of bank where recipient have the account and will receive the payment.
\nOriginator Info: In case or FI customers, details of Originator information who send the payment through clients.
\niii. Payment
\nA Payment represents an individual payment instruction. A Payment can include information such as:
\nPayment amount
\nPayment currency
\nPayment method
\nSettlement amount
\nSettlement currency
\nSettlement method
\nFees
\nPayee information
\niv. Deal
\nA Deal is a collection of one or more payment objects. With the help of Deal, multiple payment instructions can be sent in bulk at once with one settlement / funding source.
\nv. Quote
\nA Quote represents the foreign exchange information of a transaction/payment with details like payment currency, settlement amount, settlement currency, settlement amount, rate, fee and total settlement amount with fee and rate calculation.
\n3.2 API Object Flow
\nThe following will be the flow of object creations using api methods/endpoint in order to book deals on the Ascendant platform.
\ni. Payee Creation
\nUse the AddPayee API method to create a Payee or UpdatePayee to update an existing Payee.
After a Payee is created successfully, AFXLink returns a PayeeID. Store this identifier in your system if you want to reuse the Payee for future payments.
You can also provide Payee information directly when calling SubmitDeal. If the Payee does not already exist, AFXLink creates the Payee before submitting the Deal. If the Payee already exists, the existing Payee information is updated before the Deal is submitted.
ii. Quote Creation
\nUse GetQuote to retrieve an FX quote for a supported currency pair.
For transfers between Ascendant accounts, use GetQuoteTBA.
The Quote provides the applicable exchange rate and calculates the corresponding payment and settlement amounts.
\niii. Accept Quote
\nUse AcceptQuote to accept the Quote before submitting the Deal.
An accepted Quote is valid for two hours. If the Quote expires before the Deal is submitted, request and accept a new Quote.
\niv. Submit Deal
\nAfter accepting the Quote, use SubmitDeal with:
A valid QuoteID
Accepted Payment information
\nA valid PayeeID or Payee object
After the Deal is created successfully, AFXLink returns an AFXDealID.
Store the AFXDealID in your system. You can use it to track the Deal and support reconciliation.
v. Retrieve Submitted Deals
\nUse PostDeal to retrieve successfully submitted and approved Deals and Payments for reconciliation with your system.
The response includes a PaymentID. Where applicable, you can use this identifier with GetPaymentStatus to retrieve payment status information from the Swift network.
vi. Confirm Reconcilliation
\nUse PostDealConfirmation to mark a Payment as reconciled in your system.
Once confirmed, subsequent PostDeal requests can return only newer or unreconciled Deal and Payment information. This helps keep responses smaller and reduces unnecessary network latency on api calls.
3.3 Use Cases For Selecting Methods
\ni. Quick Quote.
Use SubmitDealAutoQuote method with payee object. This will create payee object and GetQuote, accept internally on the basis of current market rate, and submit the deal.
ii. Quote Approval before before submitting deal
Use GetQuote, AcceptQuote and SubmitDeal in same sequence.
iii. Create payee database to reuse for subsequent calls.
\nUse AddPayee followed by SubmitDealAutoQuote with PayeeID reference or (GetQuote + _AcceptQuote_+ SubmitDeal ) with PayeeID reference
\niv. Manual approval on web platform, after submiting deals through API
\nUse SubbmitDealForApproval along with GetQuote and AcceptQuote.
\nAfter submitting successfully, you will get list of all these deals on aPay online portal where deals can be reviewed as pet setup approval rules and can be release for payment.
\n3.4 API METHODS
Check out the list of methods in the list. Explore possible use cases/objectives you can meet with using them.
Request
\nSr.No. | Attribute | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | 15 | Client specific value provided by Ascendant | Not null | CustomerID |
2 | MethodID | Alpha Numeric | 10 | AFXEWSGQ | Not null | Value will always be \"AFXEWSGQ\" |
3 | TotalNumberOfPayment | Integer | 5 | Not null | Provide the number of payments in the given deal | |
4 | Payment | ArrayOfDeal | ||||
4.1 | PaymentSequenceNo | Integer | 5 | Not null | Sequence the payments | |
4.2 | Direction | Enum | 4 | Buy = 0 and Sell =1 | Not null | Customer stand point |
4.3 | PaymentMethod | Char | Buy Direction: Allowed Methods are: Wire,ACH, EFT, Draft Sell Direction: Allowed Methods are: Wire, Cheque, ACHDebit, PAD | Not null | ||
4.4 | FX Currency ID | Char | 3 | 3 Letter ISO Code | Not null, valid currency id | |
4.5 | FX Amount | Number | 15,9 | 4.5 or 4.6 Not null, greater than zero | ||
4.6 | Settlement Amount | Number | 15,9 | 4.5 or 4.6 Not null, greater than zero | ||
4.7 | Settlement Currency ID | Char | 3 | 3 Letter ISO Code | Not null, valid currency id | |
4.8 | OriginatorType - Consumer / Business | Enum | 1 | Consumer =0 Business = 1 | null | Consumer / Business Not applicable in Sell request |
4.9 | Fee | Number | 0 | Not null – Put Zero value tag 0 | Not applicable in request. Will be provided in response if applicable | |
5.0 | Rate | Number | 0 | Not null – Put Zero value tag 0 | Not applicable in request. Will be provided in response | |
5.1 | TotalSettlementAmount | Number | 0 | Not null – Put Zero value tag 0 | Not applicable in request. Will be provided in response |
Response
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Same as in Request | Customer id of BB site |
2 | TotalNumberOfPayment | Integer | 5 |
| Not null | Provide the number of payments in the given deal |
3 | Payment | ArrayOfDeal |
|
|
|
|
3.1 | PaymentSequenceNo | Integer | 5 |
| Not null | Sequence the payments |
3.2 | Direction | Enum | 4 | Buy =0 and Sell = 1 | Not null | Customer stand point |
3.3 | PaymentMethod | Char |
| If Buy: Wire, ACH, EFT, Draft
If Sell: Wire, Cheque | Not null |
|
3.4 | FX Currency ID | Char |
| 3 Letter ISO Code | Not null, valid currency id | |
3.5 | FX Amount | Number | 15,9 |
| Greater than Zero |
|
3.6 | Settlement Currency ID | Char | 3 | 3 Letter ISO Code | Not null, valid currency id | |
3.7 | Rate |
|
|
|
|
|
3.8 | Settlement Amount | Number | 15,9 |
| Greater than Zero |
|
3.9 | Fee | Number |
|
|
|
|
3.10 | TotalSettlementAmount | Number | 15,9 |
| Greater than Zero |
|
4 | QuoteID | Alpha Numeric | 15 |
|
|
|
5 | QuoteDateTime | DateTime | 16 |
|
|
|
6 | QuoteExpiryTime | DateTime | 16 |
| Quote expires after this moment. After this point, a new quote will need to be requested. Ref configuration tab. | |
7 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
8 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
Quote Validity
\nQuote is valid (rate hold) for 45 seconds after which it expires and cannot be used. A fresh new quote must be requested.
\n","urlObject":{"path":["api","GetQuote"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"5e0d53a9-5d05-4217-bdf7-c8bed361e342","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"MethodID\": \"AFXEWSGQ\",\r\n \"OrgID\": \"1871761\",\r\n \"Payment\": [\r\n {\r\n \"Direction\": 0,\r\n \"Fee\": 0,\r\n \"FxAmount\": 1,\r\n \"FxCurrencyID\": \"USD\",\r\n \"OriginatorType\": 0,\r\n \"PaymentMethod\": \"Wire\",\r\n \"PaymentSequenceNo\": 1,\r\n \"Rate\": 0,\r\n \"SettlementAmount\": 0,\r\n \"SettlementCurrencyID\": \"USD\",\r\n \"TotalSettlementAmount\": 0\r\n }\r\n ],\r\n \"TotalNumberOfPayment\": 1\r\n }","options":{"raw":{"language":"json"}}},"url":"https://afxlink-staging.ascendantfx.com/api/GetQuote"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Server","value":"Microsoft-IIS/10.0","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Date","value":"Thu, 09 Nov 2023 10:03:25 GMT","enabled":true},{"key":"Content-Length","value":"400","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"Payment\": [\n {\n \"Direction\": 0,\n \"Fee\": 10,\n \"FxAmount\": 1,\n \"FxCurrencyID\": \"USD\",\n \"OriginatorType\": 0,\n \"PaymentMethod\": \"Wire\",\n \"PaymentSequenceNo\": 1,\n \"Rate\": 1,\n \"SettlementAmount\": 1,\n \"SettlementCurrencyID\": \"USD\",\n \"TotalSettlementAmount\": -9\n }\n ],\n \"Quote\": {\n \"ExpiryTime\": \"/Date(1699531405295-0500)/\",\n \"ID\": 2727563,\n \"QuoteDateTime\": \"/Date(1699524205295-0500)/\"\n },\n \"TotalNumberOfPayment\": 1\n}"}],"_postman_id":"4bdc9b99-b557-4398-9aa1-83661c607039"},{"name":"AcceptQuote","event":[{"listen":"prerequest","script":{"exec":["pm.collectionVariables.get(\"BaseURL\");\r","pm.collectionVariables.get(\"APIUsername\");\r","pm.collectionVariables.get(\"APIPassword\");\r","pm.collectionVariables.get(\"OrgID\");\r",""],"type":"text/javascript","packages":{},"id":"20743c27-a7b8-455d-97be-a253e8101cfc"}}],"id":"38d8889b-f569-4082-b8a8-5c5b1e81a939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":"Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null | Customer id of BB site |
2 | MethodID | Alpha Numeric | 10 | AFXEWSAQ | Not null | Constant |
3 | QuoteID | Alpha Numeric | 15 |
| Valid Quote, not null | As provided in response to GetQuote |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Validation | Customer id of BB site |
2 | QuoteID | Alpha Numeric | 15 |
|
|
|
3 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
4 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Not null | |||
2 | MethodID | Alpha Numeric | AFXWSVIFSQ | Not null | Constant | |
3 | FromAccountNumber | Alpha Numeric | Will be provided | Not null | ||
4 | FxAmount | Number | 15,9 | Not null,greater than zero | ||
5 | ToAccountNumber | Alpha Numeric | ||||
6 | SettlementAmount | Number | 15,9 | Not null, greater than zero | ||
7 | Fee | Decimal | ||||
8 | FXCurrencyID | Char | ||||
9 | Payement Method | Char | ||||
10 | Rate | Decimal | ||||
11 | SettlementCurrencyID | Char | ||||
12 | TotalSettlementAmount | Number |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | FromAccountNumber | Alpha Numeric | Same as in request | |||
2 | ToAccountNumber | Alpha Numeric |
|
| Same as in request | |
3 | FxAmount | Number | 15,9 | |||
4 | SettlementAmount | Number | 15,9 | |||
5 | Quote | Array of QuoteDetail | ||||
5.1 | ID | Alpha Numeric | ||||
5.2 | QuoteDateTime | DateTime | ||||
5.3 | QuoteExpiryTime | DateTime | 16 | Quote expires. After this point, a new quote will need to be requested. | ||
6 | PaymentMethod | Char | ||||
7 | FxCurrencyID | Alpha Numeric | ||||
8 | SettlementCurrencyID | Alpha Numeric | ||||
9 | Rate | Number | 15,9 | |||
10 | Fee | Number | 15,9 | |||
11 | TotalSettlementAmount | Number | 15,9 | |||
12 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
13 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
The GetRateQuick API returns the FX Rate for your OrgID used to buy or sell a specified currency pair. The rate is provided based on the following parameters:
\nDirection – Indicates whether the request is for a Buy or Sell rate.
\nFX Currency – The currency being requested (to buy or sell).
\nSettlement Currency – The currency in which the transaction will be settled.
\nNote: Only one currency pair (FX Currency + Settlement Currency) can be specified per API call. The Buy and Sell rates for the same currency will differ.
\nThis API is designed for retrieving real-time indication FX rates prior to initiating a deal or payment, allowing you to validate pricing and ensure accuracy.
\nThe GetRateQuick API always returns Indirect rates, in line with our other APIs, to ensure a consistent experience across the platform. Indirect rate can be different depending on if you are selling or buying currency.
\nWhen requesting rates for non-common currencies, at least one side of the pair (FX Currency or Settlement Currency) should be a common currency (preferably USD) to ensure a successful response.
\nTwo non-common currencies in the same request may result in the rate provider not returning a rate.
\nExample: Requesting AWG->AZN will return the error: Currency Pair AWGAZN. RateNotAvailableContactTrader(0001)
\nRetrieve the rate in two steps, using USD as the intermediary:
\nGet AWG->USD
\nGet USD->AZN
\nBy combining the two results, you can derive the desired non-common currency rate.
\nThese methods can be used to get various type of quotes like simple quote, quick rate, Quote for transfer between accounts and accept quotes.
\n","_postman_id":"f487bfea-f6f8-45a0-a6f3-05bb2e1725dd"},{"name":"Submit Deal","item":[{"name":"SubmitDeal_0_0_2","event":[{"listen":"prerequest","script":{"exec":["pm.collectionVariables.get(\"BaseURL\");\r","pm.collectionVariables.get(\"APIUsername\");\r","pm.collectionVariables.get(\"APIPassword\");\r","pm.collectionVariables.get(\"OrgID\");"],"type":"text/javascript","id":"2b7a2e68-672a-4ed6-be0f-ef70a3cdcc85"}}],"id":"8688403c-f7d6-4fc8-aa6d-3b63a651362c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":"Sr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description | |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Same as in Request | Constant | |
2 | TotalNumberOfPayment | Integer | 5 |
| Not null | ||
3 | DealID | Alpha Numeric | 15 |
|
|
| |
6 | All other object info provided in Request |
| |||||
3 | TotalSettlementAmount | Number | 15,9 |
|
| ||
7 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure | |
8 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
Sr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Note |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Same as in Request | Constant |
2 | TotalPayment | Integer | 5 |
| Not null | |
3 | DealID | Alpha Numeric | 15 |
|
|
|
4 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
5 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
6 | All other object info provided in Request |
|
|
|
|
|
AUTO BANK LOOKUP & POPULATION
This is only available for Payment Method = EFT or Account Number = IBAN
The SubmitDealAutoQuote API allows you to submit a new FX deal without manually requesting and accepting a quote. When this API call is received by AFXLink, a quote is automatically generated and accepted in real time, streamlining the deal submission process.
Alternatively, you can also use SubmitDealAutoQuote with a manually created quote obtained via the GetQuote API. In this case, you must ensure that the following fields in the SubmitDealAutoQuote request match the original quote:
Direction
\nPaymentMethod
\nFXCurrencyID
\nFXAmount
\nSettlementCurrencyID
\nSettlementAmount
\nThis ensures consistency and successful deal processing.
\nYou can specify Settlement Account using SettlementMethod and SettlementAccountID. Both values should be provided as combination of method and Account ID
\nSettlementMethod supports 4 values to specify which Settlement Account by method:
\nachdebit
\nwire
\npad
\nholdingac
\nNotes: values are case insensitive.
\nSettlementAccountID value is expected to contain:
\nID of Holding Account when SettlementMethod = holdingac
\nID of Payor when SettlementMethod = achdebit, wire or pad
\nWhen Settlement Account (SettlementMethod and SettlementAccountID) are not provided AFXLink will use default Settlement Account configured for your OrgID.
\nYou have an option to specify Deal direction via Direction property:
\n0 - Buy (Funds transferred TO specified Payee/Payor)
\n1 - Sell (Funds charged FROM specified Payee/Payor)
\nYou can specify if new Deal with Payments require approval or not. To do that you should use IsApprovalRequired property. It supports 2 values:
\n0 - Deal doesn’t required approval
\n1 - Deal requires approval
\nWhen IsApprovalRequired property is not provided in API call, the System treats it as Deal doesn’t required approval.
\nAFXLink can validate Payment for duplicates using your External ID, which you should provide in YourPaymentId.
\nUsing YourPaymentId AFXLink will validate if Payments created for the last month (from Current Date - 1 month to Current Date) with the same YourPaymentId already exist in the System.
\nYou have 2 options to specify Payee/Payor data:
\nIF Payee/Payor already exists in the Ascendant - simply provide Payee/Payor ID via PayeeID property within PayeeDetail object in API
\nIF Payee/Payor doesn’t exists in the Ascendant - provide all required properties for PayeeDetail object in API
\nWhen PayeeID is provided, AFXLink will use stored data for this Payee/Payor in the Ascendant system and ignore any other data provided within PayeeDetail object in API.
\nNotes: Stored Payee/Payor data in this case will stay as-is in the Ascendant system and cannot be updated with other data provided within PayeeDetail object in API.
\nWhen you will submit SubmitDealAutoQuote with Direction = 0 and PayeeID = 0 or Null, Ascendant system will automatically create new Payee with provided data within PayeeDetail object in API with next specifics:
\nPayment Method = PayeeBankRoutingType value
\nCurrency = FXCurrencyID value
\nNickname = Null
\nInternal Reference = PayeeName value
\nPayeeID = Auto-generated value
\nInternal Notes: Doesn’t work for Direction = 1
\nYou can provide Originator data in 2 ways:
\nProvide only OriginatorID property and system will pick up all other data from the System
\nProvide all Originator data in API without need to specify OriginatorID
\nPayee Duplication check is disabled for SubmitDeals APIs
\nRequest
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description | |
|---|---|---|---|---|---|---|---|
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null | Customer id of BB site | |
2 | MethodID | Alpha Numeric | 10 | AFXEWSSD | Not null | Constant | |
3 | QuoteID | Alpha Numeric | 15 |
| Valid Quote, not null | As provided in response to GetQuote | |
4 | TotalNumberOfPayment | Integer | 5 |
| Not null | Provide the number of payments in the given dea | |
5 | DealDetail | ArrayOfDealDetail |
|
|
| ||
5.1 | PaymentSequenceNo | Integer | 5 |
| Not null | Sequence the payments | |
5.2 | PaymentMethod | Char |
| For Buy –Wire,ACH,EFT , For Sell –Wire,Cheque, ACHDebit, PAD | Not null | ||
5.3 | FX Currency ID | Char |
| 3 Letter ISO Code | Not null, valid currency id | ||
5.4 | FX Amount | Number | 15,9 |
| 5.4 OR 5.5 Not null, greater than zero | ||
5.5 | Settlement Amount | Number | 15,9 |
| 5.4 OR 5.5 Not null, greater than zero | ||
5.6 | Settlement Currency ID | Char | 3 | 3 Letter ISO Code | Not null, valid currency id | ||
5.7 | InternalReference | Alpha Numeric | 500 |
|
| ||
5.9 | Sender | Senderobject |
|
|
| ||
5.9.1 | SenderName | Alpha Numeric | 35 |
| Not null | ||
5.9.2 | SenderID | Number |
|
|
| Not required any other Senderinfo if valid SenderID is provided | |
5.9.3 | SenderAddress1 | Alpha Numeric | 35 |
| Not null | ||
5.9.4 | SenderAddress2 | Alpha Numeric | 35 |
| Null allowed | ||
5.9.5 | SenderCity | Alpha Numeric | 100
|
| Not null | ||
5.9.6 | SenderProvince | Alpha Numeric |
|
|
| ||
5.9.7 | SenderCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id | ||
5.9.8 | SenderPostalCode | Alpha Numeric |
|
|
| ||
5.9.9 | SenderBankName | Alpha Numeric | 35 |
|
| ||
5.9.10 | SenderAccountIBANNumber | Alpha Numeric | 34 |
| Not null |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Note | |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Same as in Request | Constant | |
2 | TotalPayment | Integer | 5 |
| Not null | ||
3 | DealID | Alpha Numeric | 15 |
|
|
| |
4 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure | |
5 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure | |
6 | InstructionToSender | InstructionToSenderObject |
|
|
|
| |
6.1 | CurrencyID | Alpha Numeric | Same as in request | ||||
6.2 | Bankname | Alpha Numeric | Trur/False | ||||
6.3 | BankAddress | Alpha Numeric | |||||
6.4 | SwiftCode | Alpha Numeric | |||||
6.5 | LocalRoutingCode | Alpha Numeric | BSB & Others | ||||
6.6 | AccountNo | Alpha Numeric | Not null | ||||
6.7 | AccountName | Alpha Numeric | Not null | ||||
6.8 | AccountAddress | Alpha Numeric | Not null | Includes Street Address, City, Province & Country Info | |||
6.9 | Memo1 | Alpha Numeric | 7 | Not null | DealID (Only Number Portion) | ||
6.10 | Memo2 | Alpha Numeric | 13 | May be Null (There will be value only for 2 – 3 currencies) | Additional Reconciliation Reference |
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description | |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null; Max Chars 15; | Customer id of BB site | |
2 | MethodID | Alpha Numeric | 10 | AFXEWSSD | Not null; Max Chars 10 | Constant | |
3 | QuoteID | Alpha Numeric | 15 | Valid Quote, not null Can be null for auto quote. | As provided in response to GetQuote | ||
4 | TotalNumberOfPayment | Integer | 5 | Not null | Provide the number of payments in the given TransactionDetail | ||
5 | TotalNumberOfSettlemnet | Integer | Provide the number of payments in the given deal | ||||
6 | TransactionDetail | Array Of PaymentDetail | |||||
6.1 | PaymentSequenceNo | Integer | 5 | Not null | Sequence the payments | ||
6.2 | Direction | Enum | 4 | Buy =0 and Sell =1 | Not null | Customer stand point | |
6.3 | PaymentMethod | Char | For Buy –Wire,ACH,EFT , For Sell –Wire,Cheque, ACHDebit, PAD | Not null | |||
6.4 | FXCurrencyID | Char | 3 Letter ISO Code | Not null, valid currency id | |||
6.5 | FXAmount | Number | 15,9 | 5.4 OR 5.5 Not null, greater than zero | |||
6.6 | SettlementAmount | Number | 15,9 | Not null, greater than zero Can be null for auto quote. | |||
6.7 | SettlementCurrencyID | Char | 3 | 3 Letter ISO Code | Not null, valid currency id | ||
6.8 | Rate | Number | 15,9 | NOt Required | |||
6.9 | Fee | Number | 15,9 | NOt Required | |||
6.10 | TotalSettlementAmount | Number | 15,9 | NOt Required | |||
6.11 | NotesToPayee | Alpha Numeric | 500 | ||||
6.12 | InternalNotes | Alpha Numeric | 500 | ||||
6.13 | PayeeId | Alpha Numeric | 100 | ||||
6.14 | PayeeName | Alpha Numeric | 100 | Not Required | |||
6.15 | PayeeEmail | Alpha Numeric | 100 | Not Required | |||
7 | SettlementDetail | Array Of SettlementDetail | |||||
7.1 | SettlementSequenceNo | Integer | 5 | Not null | Sequence the Settlement | ||
7.2 | SettlementMethod | Char | Wire, ACH, EFT, PAD, HOLDINGAC | Not null | |||
7.3 | SettlementAccountOrgID | Alpha Numeric | 100 | ||||
7.4 | SettlementAccountID | Alpha Numeric | 100 | ||||
7.5 | SettlementCurrencyID | Char | 3 | 3 Letter ISO Code | Not null, valid currency id | ||
7.6 | SettlementAmount | Number | 15,9 | Not null, greater than zero | |||
7.7 | SettlementAccountName | Alpha Numeric | Not Required | ||||
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Note |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Same as in Request | Constant |
2 | TotalNumberofPayment | Integer | 5 |
| Not null | |
3 | TotalNumberOfSettlemnet | Integer | 5 | Not null | ||
3 | DealID | Alpha Numeric | 15 |
|
|
|
4 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
5 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
6 | All other object info provided in Request |
|
|
|
|
|
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Not null | |||
2 | MethodID | Alpha Numeric | AFXEWSAQ | Not null | Constant | |
3 | QuoteID | Alpha Numeric | Not null |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
3 | DealID | Integer | ||||
4 | DealNumber | Alpha Numeric | Full deal number: AFX CA-DEAL-0003042 | |||
5 | QuoteID | Alpha Numeric | Same as in request |
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null | Customer id of BB site |
2 | MethodID | Alpha Numeric | 10 | AFXEWDPDBI | Not null | Constant |
3 | DealID | Integer | 8 |
| not null | As provided in |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | DealID | Integer | 8 | Will be provided | Same as |
|
2 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
3 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
GetAccountBalance API call allows to receive data of all your AFX Holding Accounts, which can be used to transfer funds from during SubmitDeal API call
\nThis API call will return list of all your AFX Holding Accounts, associated with your OrgID, with the next data:
\nAccount ID
\nAccount Number
\nAccount Currency
\nAccount Balance
\nGetAccountActivity API allows to get AFX Holding Account activity history for specified AccountNumber.
\nGetAccountActivity supports 3 filters to filter AFX Holding Account activity history:
\nFilter by Date periods (see Date range filter section below)
\nFilter by Transaction Type (see Transaction Types filter section below)
\nFilter by Deal Number (see Deal Number Filter section below)
\nYou can apply multiple filters simultaneously to narrow down the results. All applied filters work together using AND logic, meaning that only records that match all specified criteria will be displayed.
\nFactor, Month and Year properties are working in combination and allows to get AFX Holding Account activity for specific period:
\nFactor = 0 with NO Month and Year - will get current month activity. Days has no effect when Factor is 0
\nFactor = 0 with Month and Year - will get that specific month activity. Days has no effect when Factor is 0
\nFactor = 1 with Month and Year - will get activity from the specified Month/Year to the current date. Days has no effect when Factor is 1
\nFactor = 4 with Days - will get activity for the last N days (including current day). Month/Year have no effect when Factor is 4
\nTransactionType property allows to filter AFX Holding Account activity to get information only about Credits/Debits or both
\nTransactionType = 0 - will get both Credit and Debit records
\nTransactionType = 1 - will get all Credit records
\nTransactionType = 2 - will get all Debit records
\nDealID property allows to search for specific Deal in AFX Holding Account activity
\nRequest
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null | Customer id of BB site |
2 | MethodID | Alpha Numeric | 10 | AFXWSVIFSC | Not null | Constant |
3 | DealID | Alpha Numeric | 15 | Full deal |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | DealID | Integer | Same as in request | |||
2 | Status | Integer | 15 | -1, 0, 1 |
| -1 - Deal reversed |
3 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
4 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
This version of Post Deal includes rate, fee, remitter name/originator name/by order of name in the response.
\nRequest
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric |
| Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
| AFXEWSDPA | Not null | Constant |
Response
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Description |
1 | ErrorCode | Integer |
|
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric |
|
| Error message |
3 | NumberOfDeals | Integer |
|
| Control number indicating number of deals in the array |
4 | Deals | Array Of DealDetails |
|
| An Array of Deal Details with deal number and amount |
4.1 | CallDateTime | datetime |
|
|
|
4.2 | OrgID |
| 15,9 |
|
|
4.3 | InitiatedBy | Alpha Numeric |
|
|
|
4.4 | AFXDealID | Alpha Numeric |
|
|
|
4.5 | AFXPaymentID | Alpha Numeric |
|
|
|
4.6 | TransactionDate | datetime |
|
|
|
4.7 | FXAmount | Number | 15,9 |
|
|
4.8 | FXCurrencyID | Alpha Numeric |
|
|
|
4.9 | Rate | Number | 15,9 |
|
|
4.10 | DebitAmount | Number |
|
|
|
4.11 | SettlementCurrencyID | Alpha Numeric |
|
|
|
4.12 | PaymentReference | Alpha Numeric |
|
|
|
4.13 | YourInternalReference | Alpha Numeric |
|
|
|
4.14 | Fee | Number | 15,9 |
|
|
4.15 | OriginatorName | Alpha Numeric | |||
4.16 | OriginatorAccountNumber | Alpha Numeric |
GetDealStatus API return Deal Status of provided Deal
\nGetDealInfo API return Deal Status for provided DealID and List of associated Payments with Settlement Amount/Currency, FX Amount/Currency, Fee and Rate information
\nPostDeal_0_0_3 API returns all Deals and their associated Payments that meet the following criteria:
\nThe Deal is created for the specified OrgID.
\nThe Deal is an Outgoing (Send) Deal.
\nThe Deal is initiated from one month prior to the current date through the current date.
\nThe Deal is approved and released in Ascendant system.
\nThe Deal has not been confirmed yet by your ERP system via the PostDealConfirmation API.
\nPay attention that PostDeal_0_0_3 doesn’t capture Incoming (Receive) Deals.
\nYou can use returned list of Deals to review in your system or as confirmation that Deals are successfully created and processed by our System. To not receive already reviewed Deals use PostDealConfirmation API call to mark them as Confirmed.
\nPostDealConfirmation API allows to mark Deals in Ascendant as confirmed.
\nYou can use returned list of Deals by PostDeal API to review in your system or as confirmation that Deals are successfully created and processed by Ascendant System. To not receive already reviewed Deals use PostDealConfirmation API call to mark them as Confirmed.
\nTo confirm whole Deal or specific Payment you need to provide DealPostCallID returned by PostDeal API, in which this Deal/Payment is listed in response, provide Deal/Payment ID and provide DealPostConfirm = 0.
\nIf you don’t want to confirm some Deals/Payment because they did not pass review on your side, you can send PostDealConfirmation API with DealPostConfirm = 1 for these Deals/Payments or just don’t send PostDealConfirmation API for them at all.
\nTo confirm all Payments in one Deal you can provide only AFXDealID, while leaving AFXPaymentID with Null value or not provide AFXPaymentID at all.
\nTo confirm only specific Payment in the Deal you need to provide AFXPaymentID value, while you can leave AFXDealID with Null value or not provide AFXDealID at all.
\nRequest
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Not null | |||
2 | MethodID | Alpha Numeric | AFXEWGIPI | Not null | Constant | |
3 | CurrencyCode | Alpha Numeric | Like CAD,USD | Not Null |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
3 | CurrencyCode | Alpha Numeric | ||||
4 | BankName | Alpha Numeric | ||||
5 | BankAddress | Alpha Numeric | ||||
6 | SfiftCode | Alpha Numeric | ||||
7 | RoutingTransit | Alpha Numeric | ||||
8 | AccountNo | Alpha Numeric | ||||
9 | AccountName | Alpha Numeric | ||||
10 | AccountAddress | Alpha Numeric | ||||
11 | Reference | Alpha Numeric | (Reference for one of our provider. Used only in 2 cases) |
The GetPaymentStatus API provides real-time tracking information for a payment. It returns key payment details along with the current status and history of each stage in the payment's transfer route.
For more information on the request and response structure, refer to the GetPaymentStatus API Request/Response Structure section.
\nRequest
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null | Customer id of BB site |
2 | MethodID | Alpha Numeric | 10 | AFXEWSFNDLST | Not null | Constant |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
3 | NumberOfAccount | Integer | Control number indicating number of accounts in the array | |||
4 | Account | Array OfAccountDetails | An Array of Account Details with Account Name and Balance | |||
4.1 | AccountID | Integer | Unique ID of the Account Use this for submitting deals to identify the settlement account | |||
4.2 | AccountNumber | Alpha Numeric | ||||
4.3 | AccountCurrencyID | Like CAD,USD | ||||
4.4 | Type | int | Values: 1 – ExternalBank AC 2 – Internal Holding AC | |||
4.5 | Bank Name | Values: External AC – Name of the Bank Internal AC – “HoldingAccount” | ||||
4.6 | PaymentMethod | Values: External AC - “Wire”, “ACHDebit”, “PAD”, “ACH”,”ABA”,”EFT” Internal AC – “HoldingAccount” | ||||
4.7 | NameOnAccount | Values: External AC – Name on the ac Internal AC – “HoldingAccount” |
AddPayee is used to create new Payee user in the System. In this API request you need to provide all required data, which is the same as in aPay (see AddPayee API Request Structure section).
\nThe System expect to receive one of 2 values Swift Code or Bank Routing Code with additional Swift Code (9-11)/Bank Code
\nSwift Code should be provided in PayeeBankSwiftCode.
\nBank Routing Code should be provided in PayeeBankRoutingCode.
\nSwift Code (9-11) / Bank Code should be provided in PayeeBankBankCode
\nThe System will accept only one of 2 values: Swift Code or Bank Routing Code (Bank Routing Code has priority when both provided)
\nYou can provide Originator data in 2 ways:
\nProvide only OriginatorID and system will pick up all other data from the System
\nProvide all data in API without need to specify OriginatorID
\nIt’s required that at least one of properties were provided: PayeeCountryID or PayeeBankCountryID
\nIF PayeeCountryID is not provided the System will take value from PayeeBankCountryID and assign it as Payee > Country
\nIF PayeeBankCountryID is not provided the System will take value from PayeeCountryID and assign it as Payee Bank > Country
\nWhen both PayeeCountryID and PayeeBankCountryID the System appropriately assign values from them to Payee > Country and Payee Bank > Country
\nWhen AddPayee is submitted the System validates that Payee with provided data doesn’t exist in the System already across active Payees.
\nNext data is validated:
\nPayeeName
\nPayeeNickName (if not-null value provided)
\nCurrencyID
\nPaymentMethod
\nPayeeBankName
\nPayeeAccountIBANNumber
\nBy Order Of data (when configured for the OrgID to be validated):
\nOriginatorName
\nOriginatorAccountNumber
\nSee Request table below with list of all fields and Allowed char regex for Alpha Numeric fields.
\nNotes: All non-supported characters are automatically removed from provided value without errors.
\nUpdatePayee is used to update data for existing Payee user in the System. In this API request you need to provide all required data, which is the same as in aPay (see UpdatePayee API Request Structure section).
\nThe System expect to receive one of 2 values Swift Code or Bank Routing Code with additional Swift Code (9-11)/Bank Code
\nSwift Code should be provided in PayeeBankSwiftCode.
\nBank Routing Code should be provided in PayeeBankRoutingCode.
\nSwift Code (9-11) / Bank Code should be provided in PayeeBankBankCode
\nThe System will accept only one of 2 values: Swift Code or Bank Routing Code (Bank Routing Code has priority when both provided)
\nYou can provide Originator data in 2 ways:
\nProvide only OriginatorID and system will pick up all other data from the System
\nProvide all data in API without need to specify OriginatorID
\nIt’s required that at least one of properties were provided: PayeeCountryID or PayeeBankCountryID
\nIF PayeeCountryID is not provided the System will take value from PayeeBankCountryID and assign it as Payee > Country
\nIF PayeeBankCountryID is not provided the System will take value from PayeeCountryID and assign it as Payee Bank > Country
\nWhen both PayeeCountryID and PayeeBankCountryID the System appropriately assign values from them to Payee > Country and Payee Bank > Country
\nWhen optional (non-required) field is not provided in Request it’s value will be updated to Null for Payee after submitting successfull UpdatePayee API request (see UpdatePayee API Request Structure section for more details)
\nRequest
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Will be provided | Not null; Max Chars - 15; |
|
2 | MethodID | Alpha Numeric | AFXEWSPOD | Constant value; Max Chars - 15; | |
3 | PayeeDetail | PayeeDetail |
| not null | [Single Node Here] |
3.1 | PayeeID | Alpha Numeric | Not null; Max Chars - 15; |
| |
3.2 | PaymentMethod | Char | Wire, Draft | Not null; Max Chars - 100; |
|
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Note |
1 | ErrorCode | Integer |
|
|
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric |
|
|
| Error message |
3 | PayeeID | Alpha Numeric |
| Payee ID of the deleted payee |
| Null if there was an error and payee was not deleted |
4 | PayeeName | Alpha Numeric |
|
|
| Null if there was an error and payee was not deleted |
5. | PayeeInternalReference | Alpha Numeric |
|
|
| Null if there was an error and payee was not deleted |
GetPayeeInfo_0_0_5 is used to retrieve data of Payee(s). This API call retrieves data of a specific user or users using Filters to search for the desired User(s) (see Available Filters)
\nGetPayeeInfo_0_0_4 is used to retrieve data of Payor(s) instead. Same filters as for GetPayeeInfo_0_0_5 can be used.
\nYou can use up to 3 filters to return desired Payee(s): PayeeID, PaymentMethod, PayeeNickName
\nYou can apply multiple filters simultaneously to narrow down the results. All applied filters work together using AND logic, meaning that only records that match all specified criteria will be displayed.
\nTo not use specific filter, provide 0 value for it (e.g. “PaymentMethod“: 0) or don’t provide this property in API > PayeeDetail at all
\nIF no Filters are provided request will return all Payees (Payors for GetPayeeInfo_0_0_4) of provided OrgID
\nRequest
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
AFXEWSGPI |
Constant | |
3 | PayeeDetails | PayeeDetail |
| not null | [Single Node Here] |
3.1 | PayeeID | Alpha Numeric | Set 0 for add payee | Not null |
|
3.2 | PayeeName | Alpha Numeric |
| Not null |
|
3.3 | CurrencyID | Char | 3 Letter ISO Code | Not null | valid currency id |
3.4 | PaymentMethod | Char | Wire, Draft | Not null |
|
3.5 | PayeeAddress1 | Alpha Numeric |
|
| |
3.6 | PayeeAddress2 | Alpha Numeric |
|
| |
3.7 | PayeeCity | Alpha Numeric |
|
| |
3.8 | PayeeProvince | Alpha Numeric |
|
| |
3.9 | PayeeCountryID | Char | 2 Letter ISO Code |
|
|
3.10 | PayeePostalCode | Alpha Numeric |
|
|
|
3.11 | PayeeBankName | Alpha Numeric |
| Not null |
|
3.12 | PayeeBankAddress1 | Alpha Numeric |
|
|
|
3.13 | PayeeBankAddress2 | Alpha Numeric |
|
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206 |
3.14 | PayeeBankCity | Alpha Numeric |
|
|
|
3.15 | PayeeBankProvince | Alpha Numeric |
|
|
|
3.16 | PayeeBankCountryID | Char | 2 Letter ISO Code | Not null, valid country id | |
3.17 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
3.18 | PayeeAccountIBANNumber | Alpha Numeric |
|
|
|
3.19 | PayeeBankSwiftCode | Alpha Numeric | SBIN1556XXX | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | Includes 3 letter swift branch code; 11 characters |
3.20 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
3.21 | PayeeBankRoutingCode | Alpha Numeric |
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
3.22 | PayeeBankBankCode | Alpha Numeric |
|
|
|
3.23 | PayeeInterBankName | Alpha Numeric | |||
3.24 | PayeeInterBankAddress2 | Alpha Numeric |
|
|
|
3.25 | PayeeInterBankAddress2 | Alpha Numeric | |||
3.26 | PayeeInterBankCity | Alpha Numeric |
|
| |
3.27 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
3.28 | PayeeInterBankCountryID | Char | 2 Letter ISO Code |
| valid country id |
3.29 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
3.30 | PayeeInterBankRoutingCodeType | Alpha Numeric |
| Not null if Inter Bank is present | Swift/ABA |
3.31 | PayeeInterBankRoutingCode | Alpha Numeric |
| Not null if Inter Bank is present | Max 8 for swift, 9 for ABA |
3.32 | PayeeInterBankBankCode | Alpha Numeric |
|
|
|
3.33 | PayeeReference | Alpha Numeric |
|
|
|
3.34 | PayeeEmail | Alpha Numeric |
| Valid email id format Nullable |
|
3.35 | OriginatorID | Alpha Numeric |
|
| If valid org id is provided, no other info is required. The relevant info will be auto populated. |
3.36 | OriginatorName | Alpha Numeric |
|
|
|
3.37 | OriginatorAddress1 | Alpha Numeric |
|
| |
3.38 | OriginatorAddress2 | Alpha Numeric |
|
|
|
3.39 | OriginatorCity | Alpha Numeric |
|
|
|
3.40 | OriginatorProvince | Alpha Numeric |
|
|
|
3.41 | OriginatorCountryID | Char | 2 Letter ISO Code |
|
|
3.42 | OriginatorType | Enum | Consumer =0 and Business =1 |
| |
3.43 | OriginatorAccountNumber | Alpha Numeric |
|
|
|
3.44 | PayeeInternalReference | Alpha Numeric | This can be internal id or reference of integrator database |
|
|
3.45 | PayeeSendingBankInstructions | Alpha Numeric |
| Max 200 character | Tax ID, Contact Name,Contact Phone |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Note |
1 | ErrorCode | Integer |
|
|
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric |
|
|
| Error message |
3 | NumberOfPayees | Integer |
| Total |
| Null if there was an error and payee was not created |
4 | NumberOfValidPayees | Integer |
| Total |
| Null if there was an error and payee was not created |
5 | NumberOfInValidPayees | Integer | Total number of payee request object containt | |||
6 | ValidationDetails | Array of ValidationDetail | ||||
6.1 | ErrorCode | 0 = Valid payee object; 1 = Invalid Payee Object | ||||
6.2 | ErrorDetails | Array of ErrorDetail | ||||
6.2.1 | FieldName | Alpha Numeric | ||||
6.2.2 | ErrorCode | |||||
6.2.3 | ErrorMessage | |||||
6.3 | PayeeDetail | Array of PayeeDetail | ||||
6.3.1 | PayeeID | Integer | ||||
6..3.2 | PayeeName | Alpha Numeric | ||||
6.3.3 | CurrencyID | Char | 3 letter ISO Code | |||
6.3.4 | PaymentMethod | Char | Wire, Draft | |||
6.3.5 | PayeeAddress1 | Alpha Numeric | ||||
6.3.6 | PayeeAddress2 | Alpha Numeric | ||||
6.3.7 | PayeeCity | Alpha Numeric | ||||
6.3.8 | PayeeProvince | Alpha Numeric | ||||
6.3.9 | PayeeCountryID | Char | 2 Letter ISO Code | |||
6.3.10 | PayeePostalCode | Alpha Numeric | ||||
6.3.11 | PayeeBankName | Alpha Numeric | ||||
6.3.12 | PayeeBankAddress1 | Alpha Numeric | ||||
6.3.13 | PayeeBankAddress2 | Alpha Numeric | ||||
6.3.14 | PayeeBankCity | Alpha Numeric | ||||
6.3.15 | PayeeBankProvince | Alpha Numeric | ||||
6.3.16 | PayeeBankCountryID | Char | ||||
6.3.17 | PayeeBankPostalCode | Alpha Numeric | ||||
6.3.18 | PayeeAccountIBANNumber | Alpha Numeric | ||||
6.3.19 | PayeeBankRoutingType | Alpha Numeric | ||||
6.3.20 | PayeeBankRoutingCode | Alpha Numeric | ||||
6.3.21 | PayeeBankBankCode | Alpha Numeric | ||||
6.3.22 | PayeeBankSwiftCode | Alpha Numeric | ||||
6.3.23 | PayeeInterBankName | Alpha Numeric | ||||
6.3.24 | PayeeInterBankAddress1 | Alpha Numeric | ||||
6.3.25 | PayeeInterBankAddress2 | Alpha Numeric | ||||
6.3.26 | PayeeInterBankCity; | Alpha Numeric | ||||
6.3.27 | PayeeInterBankProvince | Alpha Numeric | ||||
6.3.28 | PayeeInterBankCountryID | Char | ||||
6.3.29 | PayeeInterBankPostalCode | Alpha Numeric | ||||
6.3.30 | PayeeInterBankRoutingCodeType | Alpha Numeric | ||||
6.3.31 | PayeeInterBankRoutingCode | Alpha Numeric | ||||
6.3.32 | PayeeInterBankBankCode | Alpha Numeric | ||||
6.3.33 | PayeeReference | Alpha Numeric | ||||
6.3.34 | PayeeEmail | Alpha Numeric | ||||
6.3.35 | OriginatorID | Integer | ||||
6.3.36 | OriginatorName | Alpha Numeric | ||||
6.3.37 | OriginatorAddress1 | Alpha Numeric | ||||
6.3.38 | OriginatorAddress2 | Alpha Numeric | ||||
6.3.39 | OriginatorCity | Alpha Numeric | ||||
6.3.40 | OriginatorProvince | Alpha Numeric | ||||
6.3.41 | OriginatorCountryID | Char | ||||
6.3.42 | OriginatorPostalCode | Alpha Numeric | ||||
6.3.43 | OriginatorType | Enum | Consumer = 0 and Business =1 | |||
6.3.44 | OriginatorAccountNumber | Alpha Numeric | ||||
6.3.45 | PayeeSendingBankInstructions | Alpha Numeric | ||||
6.3.46 | PayeeInternalReference | Alpha Numeric |
Request
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Will be provided | Not null | Customer id |
2 | MethodID | Alpha Numeric | AFXEWSGPI | Not null | Constant |
3 | PayorID | Integer | Optional,As provided in response to AddPayee | ||
4 | YourPayorID | Alpha Numeric | Optional, Payee |
|
Response
\nSr.No. | Attributes | Data Type | Value | Description |
1 | ErrorCode | Integer |
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric |
| Error message |
3 | NumberOfPayors | Alpha Numeric |
|
|
4 | PayorDetail | PayeeDetail |
|
|
4.1 | PayorID | Number | ||
4.2 | PayorName | Alpha numeric | ||
4.3 | PayorNickName | Alpha numeric | ||
4.4 | CurrencyID | Char | 3 Letter ISO Code | valid currency id |
4.5 | PaymentMethod | Alpha Numeric | ||
4.6 | PayorAddress1 | Alpha Numeric | ||
4.7 | PayorAddress2 | Alpha Numeric | ||
4.8 | PayorCity | Alpha Numeric | ||
4.9 | PayorProvince | Alpha Numeric | ||
4.10 | PayorCountryID | Char | 2 Letter ISO Code | Not Null,valid countryid |
4.11 | PayorPostalCode | Alpha Numeric | ||
4.12 | PayorBankName | Alpha Numeric | Not null | |
4.13 | PayorBankAddress1 | Alpha Numeric | Not null | |
4.14 | PayorBankAddress2 | Alpha Numeric | Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206, CLABE 123456789 | |
4.15 | PayorBankCity | Alpha Numeric | ||
4.16 | PayorBankProvince | Alpha Numeric | ||
4.17 | PayorBankCountryID | Char | 2 Letter ISO Code | Noy null,valid countryid |
4.18 | PayorBankPostalCode | Alpha Numeric | ||
4.19 | PayorAccountIBANNumber | Alpha Numeric | Not null | |
4.20 | PayorBankRoutingType | Alpha Numeric | WIRE, SWIFT, ACH, EFT, ABA,SEPA | |
4.21 | PayorBankRoutingCode | Alpha Numeric | 8 or 11 Characters SWIFT Code | |
4.22 | PayorBankBankCode | Alpha Numeric | Required for EFT, Use this for Transit Institution ID | |
4.23 | PayorBankSwiftCode | Alpha Numeric | Required for EFT, Use this for Transit Institution ID | |
4.24 | PayorInterBankName | Alpha Numeric | ||
4.25 | PayorInterBankAddress1 | Alpha Numeric | ||
4.26 | PayorInterBankAddress2 | Alpha Numeric | ||
4.27 | PayorInterBankCity | Alpha Numeric | ||
4.28 | PayorInterBankProvince | Alpha Numeric | ||
4.29 | PayorInterBankCountryID | Char | 2 Letter ISO Code | Not null,Valid countryid |
4.30 | PayorInterBankPostalCode | Alpha Numeric | ||
4.31 | PayorInterBankRoutingCodeType | Alpha Numeric | Can be Null if Inter Bank information is not available Swift, Wire, ABA, EFT | |
4.32 | PayorInterBankRoutingCode | Alpha Numeric | Not null if Inter Bank is present | |
4.33 | PayorInterBankBankCode | Alpha Numeric | Required for EFT, Use this for Transit Institution ID | |
4.34 | PayorReference | Alpha Numeric | ||
4.35 | PayorEmail | Alpha Numeric | Nullable | Valid id format |
4.36 | OriginatorID | Alpha Numeric | ORG ID If valid org id (of your customer) is provided, no other info is required. The relevant info will be auto populated. | |
4.37 | OriginatorName | Alpha Numeric | ||
4.38 | OriginatorAddress1 | Alpha Numeric | ||
4.39 | OriginatorAddress2 | Alpha Numeric | ||
4.40 | OriginatorCity | Alpha Numeric | ||
4.41 | OriginatorProvince | Alpha Numeric | ||
4.42 | OriginatorCountryID | Char | 2 Letter ISO Code | Not null,Valid countryid |
4.43 | OriginatorPostalCode | Alpha Numeric | ||
4.44 | OriginatorType | Enum | Consumer = 0 and Business =1 | |
4.45 | OriginatorAccountNumber | Alpha Numeric | ||
4.46 | PayorSendingBankInstructions | Alpha Numeric | Tax ID 1234 or Contact Name: JinXiajuan Put all additional info in this field. No 88 special characters | |
4.47 | PayorInternalReference | Alpha Numeric |
Request
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Will be provided | Not null | |
2 | MethodID | Alpha Numeric | AFXEWSSPR | Not null | Constant |
3 | PayeeName | Alpha Numeric | Not null | ||
4 | PayeeNickName | Alpha Numeric | Optional, Payee |
| |
5 | PayeeCurrency | Alpha Numeric | Not null | ||
6 | PayeeEmail | Alpha Numeric | Valid Email |
Response
\nSr.No. | Attributes | Data Type | Value | Description |
1 | ErrorCode | Integer |
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric |
| Error message |
3 | UserMessage | Alpha Numeric |
|
|
Request
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Will be provided | Not null | |
2 | MethodID | Alpha Numeric | AFXGPDF | Not null | Constant |
3 | PayeeType | Alpha Numeric | Indiv or Corporate | Not null | |
4 | CountryId | Alpha Numeric |
| ||
5 | CurrencyId | Alpha Numeric | Not null |
Response
\nSr.No. | Attributes | Data Type | Value | Description |
1 | ErrorCode | Integer |
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric |
| Error message |
3 | UserMessage | Alpha Numeric |
|
|
4 | CountryId | Alpha Numeric | ||
5 | CurrencyId | Alpha Numeric | ||
6 | DynamicFields | |||
6.1 | BeginsWith | |||
6.2 | CharacterType | Alpha Numeric | ||
6.3 | ColumnId | Alpha Numeric | ||
6.4 | ColumnName | Alpha Numeric | ||
6.5 | Length | |||
6.6 | SizeType |
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description | ||||
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null | Customer id of BB site | ||||
2 | MethodID | Alpha Numeric | 10 | AFXEWSVIBN | Not null | Constant | ||||
3 | IBANNumber | Alpha Numeric | 15 | not null | Provide the IBAN # to Validate |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
3 | IBANNumber | Alpha Numeric | ||||
4 | BankName | Alpha Numeric | ||||
5 | Country | Alpha Numeric | ||||
6 | CountryCode | Char | 2 | 2 Letter ISO Code | Not null, valid country id | |
7 | City | Alpha Numeric | ||||
8 | Address | Alpha Numeric | ||||
9 | SwiftCode | Alpha Numeric | ||||
10 | Valid | Boolean | ||||
11 | RoutingCode | Alpha Numeric | ||||
12 | BeneficiaryBankCode | Alpha Numeric | ||||
13 | BeneficiaryBankRoutingCode | Alpha Numeric | ||||
14 | BeneficiaryBankCountryId | Char | 2 | 2 Letter ISO Code | Not null, valid country id |
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description | |||
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null | Customer id of BB site | |||
2 | MethodID | Alpha Numeric | 10 | AFXEWSVRC | Not null | Constant | |||
3 | ABANumber | Alpha Numeric | 15 | not null | Provide the ABA Number # to Validate |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
3 | ABANumber | Alpha Numeric | Provided in the response | |||
4 | BankName | Alpha Numeric | ||||
5 | City | Alpha Numeric | ||||
6 | Province | Char | ||||
7 | BranchBIC | Alpha Numeric | ||||
8 | CountryCode | Alpha Numeric | ||||
9 | CurrencyCode | Alpha Numeric | ||||
10 | PostalCode | Alpha Numeric | ||||
11 | Isvalid | Boolean Numeric |
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description | ||
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null | Customer id of BB site | ||
2 | MethodID | Alpha Numeric | 10 | AFXEWSVRC | Not null | Constant | ||
3 | RoutingCode | Alpha Numeric |
| |||||
4 | CountryCode | Alpha Numeric | ||||||
5 | CurrencyCode | Alpha Numeric | ||||||
6 | RoutingType | Alpha Numeric | Like ABA,SWIFT,TRANSIT etc |
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
3 | RoutingCode | Alpha Numeric | Provided in the response | |||
4 | BankName | Alpha Numeric | ||||
5 | Address | Alpha Numeric | ||||
6 | City | Alpha Numeric | ||||
7 | Province | Alpha Numeric | ||||
8 | BranchBIC | Alpha Numeric | ||||
9 | CountryCode | Alpha Numeric | ||||
10 | CurrencyCode | Alpha Numeric | ||||
11 | PostalCode | Alpha Numeric | ||||
12 | RoutingType | Alpha Numeric | ||||
13 | IsValid | Boolean |
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null |
2 | MethodID | Alpha Numeric | 10 | AFXEWSSD | Not null |
3 | QuoteID | Alpha Numeric | 15 |
| Valid Quote, not null |
4 | TotalNumberOfPayment | Integer | 5 |
| Not null |
5 | DealDetail | ArrayOfDealDetail |
|
|
|
5.1 | PaymentSequenceNo | Integer | 5 |
| Not null |
5.2 | Direction – Buy/Sell | Enum | 4 | Buy = 0 and Sell = 1 | Not null |
5.3 | PaymentMethod | Char |
| For Buy –Wire,ACH,EFT , For Sell –Wire,Cheque, ACHDebit, PAD | Not null |
5.4 | FX Currency ID | Char |
| 3 Letter ISO Code | Not null, valid currency id |
5.5 | FX Amount | Number | 15,9 |
| 5.4 OR 5.5 Not null, greater than zero |
5.6 | Settlement Amount | Number | 15,9 |
| 5.4 OR 5.5 Not null, greater than zero |
5.7 | Settlement Currency ID | Char | 3 | 3 Letter ISO Code | Not null, valid currency id |
5.8 | NotesToPayee | Alpha Numeric | 500 |
|
|
5.9 | InternalNotes | Alpha Numeric | 500 |
|
|
5.10 | Payee | Payee object |
|
|
|
5.10.1 | PayeeName | Alpha Numeric | 35 |
| Not null |
5.10.2 | PayeeID | Number |
|
|
|
| PayeeNickname |
|
|
|
|
5.10.3 | PayeeAddress1 | Alpha Numeric | 35 |
| Not null |
5.10.4 | PayeeAddress2 | Alpha Numeric | 35 |
| Null allowed |
5.10.5 | PayeeCity | Alpha Numeric | 100
|
| Not null |
5.10.6 | PayeeProvince | Alpha Numeric |
|
|
|
5.10.7 | PayeeCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id |
5.10.8 | PayeePostalCode | Alpha Numeric |
|
|
|
5.10.9 | PayeeBankName | Alpha Numeric | 35 |
|
|
5.10.10 | PayeeBankAddress1 | Alpha Numeric | 35 |
|
|
5.10.11 | PayeeBankAddress2 | Alpha Numeric | 35 |
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206, CLABE 123456789 |
5.10.12 | PayeeBankCity | Alpha Numeric |
|
| Not null |
5.10.13 | PayeeBankProvince | Alpha Numeric |
|
|
|
5.10.14 | PayeeBankCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id |
5.10.15 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
5.10.16 | PayeeAccountIBANNumber | Alpha Numeric | 34 |
| Not null |
5.10.17 | PayeeBankSwiftCode | Alpha Numeric | 11 | 8 or 11 Characters SWIFT Code | Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
5.10.18 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
5.10.19 | PayeeBankRoutingCode | Alpha Numeric |
|
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
5.10.20 | PayeeBankBankCode | Alpha Numeric |
|
| Required for EFT, Use this for Transit Institution ID |
5.10.21 | PayeeInterBankName | Alpha Numeric | 35 |
| Not null for wire |
5.10.22 | PayeeInterBankAddress1 | Alpha Numeric | 35 |
|
|
5.10.23 | PayeeInterBankAddress2 | Alpha Numeric | 35 |
|
|
5.10.24 | PayeeInterBankCity | Alpha Numeric |
|
| Not null |
5.10.25 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
5.10.26 | PayeeInterBankCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id |
5.10.27 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
5.10.28 | PayeeInterBankRoutingCodeType |
| 10 |
| Can be Null if Inter Bank information is not available |
5.10.29 | PayeeInterBankRoutingCode | Alpha Numeric | 9 |
| Not null if Inter Bank is present |
5.10.30 | PayeeInterBankBankCode | Alpha Numeric |
|
| Required for EFT, Use this for Transit Institution ID |
5.10.31 | PayeeReference | Alpha Numeric | 500 |
|
|
5.10.32 | PayeeEmail |
|
|
| Valid email id format Nullable |
5.10.33 | OriginatorID | Alpha Numeric |
|
ORG ID | If valid org id (of your customer) is provided, no other info is required. The relevant info will be auto populated. |
5.10.34 | OriginatorName | Alpha Numeric | 35 |
| Not null |
5.10.35 | OriginatorAddress1 | Alpha Numeric | 35 |
| Not null, No P.O.Box |
5.10.36 | OriginatorAddress2 | Alpha Numeric | 35 |
|
|
5.10.37 | OriginatorCity | Alpha Numeric |
|
| Not null |
5.10.38 | OriginatorProvince | Alpha Numeric |
|
| Not null |
5.10.39 | OriginatorCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id |
5.10.40 | OriginatorPostalCode | Alpha Numeric |
|
|
|
5.10.41 | OriginatorType | Enum | 1 | Consumer =0 and Business = 1 |
|
5.10.42 | OriginatorAccountNumber | Alpha Numeric | 34 |
| Not null |
5.10.43 | PayeeSendingBankInstructions | Alpha Numeric | 2000 |
| Tax ID 1234 or Contact Name: JinXiajuan |
Payee Information (Below Section 5.10 to 5.10.43) IS REQUIRED ONLY when Direction = Buy (Outgoing Payments).For Direction = Sell (Incoming Payments), leave them empty.
\nSee appendix for samples on swift and routing code entries
\nField Value Validation: following literals are not allowed in any payee field
\"none\", \"xml\", \"html\", \"xxx\", \"xxxx\", \"xxxxxx\", \"xx\", \"x\", \"unknown\", \"P O BOX\", \"P OBOX\", \"P O BOX\", \"PO BOX\", \"p o box\", \"p obox\", \"p o box\", \"po box\", \"POBOX\", \"pobox\".
This method will decline a response if the account is not cleared by compliance. Message provided = \" Validation Error- Client is not allowed to transact\"
\nResponse
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Note |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Same as in Request | Constant |
2 | TotalPayment | Integer | 5 |
| Not null | |
3 | DealID | Alpha Numeric | 15 |
|
|
|
4 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
5 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
6 | All other object info provided in Request |
|
|
|
|
|
AUTO BANK LOOKUP & POPULATION
This is only available for Payment Method = EFT or Account Number = IBAN
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null |
2 | MethodID | Alpha Numeric | 10 | AFXEWSSD | Not null |
3 | SettlementMethod | Char | Values: Wire, PAD, ACHDebit, HoldingAC | ||
4 | SettlementAccountID | Integer | Not null | ||
5 | QuoteID | Alpha Numeric | 15 |
| Valid Quote, not null |
6 | TotalNumberOfPayment | Integer | 5 |
| Not null |
7 | DealDetail | ArrayOfDealDetail |
|
|
|
7.1 | PaymentSequenceNo | Integer | 5 |
| Not null |
7.2 | Direction – Buy/Sell | Enum | 4 | Buy = 0 and Sell = 1 | Not null |
7.3 | PaymentMethod | Char |
| For Buy –Wire,ACH,EFT , For Sell –Wire,Cheque, ACHDebit, PAD | Not null |
7.4 | FX Currency ID | Char |
| 3 Letter ISO Code | Not null, valid currency id |
7.5 | FX Amount | Number | 15,9 |
| 5.4 OR 5.5 Not null, greater than zero |
7.6 | Settlement Amount | Number | 15,9 |
| 5.4 OR 5.5 Not null, greater than zero |
7.7 | Settlement Currency ID | Char | 3 | 3 Letter ISO Code | Not null, valid currency id |
7.8 | NotesToPayee | Alpha Numeric | 500 |
|
|
7.9 | InternalNotes | Alpha Numeric | 500 |
|
|
7.10 | Payee | Payee object |
|
|
|
7.10.1 | PayeeName | Alpha Numeric | 35 |
| Not null |
7.10.2 | PayeeID | Number |
|
|
|
7.10.3 | PayeeAddress1 | Alpha Numeric | 35 |
| Not null |
7.10.4 | PayeeAddress2 | Alpha Numeric | 35 |
| Null allowed |
7.10.5 | PayeeCity | Alpha Numeric | 100
|
| Not null |
7.10.6 | PayeeProvince | Alpha Numeric |
|
|
|
7.10.7 | PayeeCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id |
7.10.8 | PayeePostalCode | Alpha Numeric |
|
|
|
7.10.9 | PayeeBankName | Alpha Numeric | 35 |
|
|
7.10.10 | PayeeBankAddress1 | Alpha Numeric | 35 |
|
|
7.10.11 | PayeeBankAddress2 | Alpha Numeric | 35 |
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206, CLABE 123456789 |
7.10.12 | PayeeBankCity | Alpha Numeric |
|
| Not null |
7.10.13 | PayeeBankProvince | Alpha Numeric |
|
|
|
7.10.14 | PayeeBankCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id |
7.10.15 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
7.10.16 | PayeeAccountIBANNumber | Alpha Numeric | 34 |
| Not null |
7.10.17 | PayeeBankSwiftCode | Alpha Numeric | 11 | 8 or 11 Characters SWIFT Code | Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
7.10.18 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
7.10.19 | PayeeBankRoutingCode | Alpha Numeric |
|
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
7.10.20 | PayeeBankBankCode | Alpha Numeric |
|
| Required for EFT, Use this for Transit Institution ID |
7.10.21 | PayeeInterBankName | Alpha Numeric | 35 |
| Not null for wire |
7.10.22 | PayeeInterBankAddress1 | Alpha Numeric | 35 |
|
|
7.10.23 | PayeeInterBankAddress2 | Alpha Numeric | 35 |
|
|
7.10.24 | PayeeInterBankCity | Alpha Numeric |
|
| Not null |
7.10.25 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
7.10.26 | PayeeInterBankCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id |
7.10.27 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
7.10.28 | PayeeInterBankRoutingCodeType |
| 10 |
| Can be Null if Inter Bank information is not available |
7.10.29 | PayeeInterBankRoutingCode | Alpha Numeric | 9 |
| Not null if Inter Bank is present |
7.10.30 | PayeeInterBankBankCode | Alpha Numeric |
|
| Required for EFT, Use this for Transit Institution ID |
7.10.31 | PayeeReference | Alpha Numeric | 500 |
|
|
7.10.32 | PayeeEmail |
|
|
| Valid email id format Nullable |
7.10.33 | OriginatorID | Alpha Numeric |
|
ORG ID | If valid org id (of your customer) is provided, no other info is required. The relevant info will be auto populated. |
7.10.34 | OriginatorName | Alpha Numeric | 35 |
| Not null |
7.10.35 | OriginatorAddress1 | Alpha Numeric | 35 |
| Not null, No P.O.Box |
7.10.36 | OriginatorAddress2 | Alpha Numeric | 35 |
|
|
7.10.37 | OriginatorCity | Alpha Numeric |
|
| Not null |
7.10.38 | OriginatorProvince | Alpha Numeric |
|
| Not null |
7.10.39 | OriginatorCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id |
7.10.40 | OriginatorPostalCode | Alpha Numeric |
|
|
|
7.10.41 | OriginatorType | Enum | 1 | Consumer =0 and Business = 1 |
|
7.10.42 | OriginatorAccountNumber | Alpha Numeric | 34 |
| Not null |
7.10.43 | PayeeSendingBankInstructions | Alpha Numeric | 2000 |
| Tax ID 1234 or Contact Name: JinXiajuan |
StartFragmentSee appendix for samples on swift and routing code entries.
\nThis method will decline a response if the account is not cleared by compliance. Message
provided = “Validation Error- Client is not allowed to transact\".EndFragment
Response
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Note |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Same as in Request | Constant |
2 | TotalPayment | Integer | 5 |
| Not null | |
3 | DealID | Alpha Numeric | 15 |
|
|
|
4 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
5 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
6 | All other object info provided in Request |
|
|
|
|
|
AUTO BANK LOOKUP & POPULATION
This is only available for Payment Method = EFT or Account Number = IBAN
Request
\nSr.No. | Attribute | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null | CustomerID |
2 | MethodID | Alpha Numeric | 10 | AFXEWSGQ | Not null | Constant |
3 | QuoteID | Alpha Numeric | 15 | Valid Quote,not null | As Providedin response to getquote | |
4 | TotalNumberOfPayment | Integer | 5 | Not null | Provide the number of payments in the given deal | |
5 | DeatDetail | ArrayOfDealdetail | ||||
5.1 | PaymentSequenceNo | Integer | 5 | Not null | Sequence the payments | |
5.2 | Direction-Buy/Sell | Enum | 4 | Buy = 0 and Sell =1 | Not null | Customer stand point |
5.3 | PaymentMethod | Char | For Direction = Buy: Allowed Methods are: Wire,ACH, EFT, Draft For Direction = Sell: Allowed Methods are: Wire, Cheque, ACHDebit, PAD | Not null | ||
5.4 | FX Currency ID | Char | 3 Letter ISO Code | Not null, valid currency id | ||
5.5 | FX Amount | Number | 15,9 | 4.5 or 4.6 Not null, greater than zero | ||
5.6 | Settlement Amount | Number | 15,9 | 4.5 or 4.6 Not null, greater than zero | ||
5.7 | Settlement Currency ID | Char | 3 | 3 Letter ISO Code | Not null, valid currency id | |
5.8 | NotestoPayee | AlphaNumeric | 500 | |||
5.9 | InternalNotes | AlphaNumeric | 500 | |||
5.10 | Payee | Payee Object | ||||
5.10.1 | PayeeName | AlphaNumeric | 35 | Not null | ||
5.10.2 | PayeeID | Number | Not required any other payee info if valid payee id provided | |||
5.10.3 | PayeeAddress1 | Alpha Numeric | 35 | Not null | ||
5.10.4 | PayeeAddress2 | Alpha Numeric | 35 | Null Allowed | ||
5.10.5 | PayeeCity | Alpha Numeric | 100 | Not null | ||
5.10.6 | PayeeProvince | AlphaNumeric | ||||
5.10.7 | PayeeCountryID | Char | 2 | 2 letter ISO Code | Not null,valid countryID | |
5.10.8 | PayeePostalCode | Alpha Numeric | ||||
5.10.9 | PayeeBank Name | Alpha Numeric | 35 | |||
5.10.10 | PayeeBankAddess1 | Alpha Numeric | 35 | |||
5.10.11 | PayeeBankAddress2 | Alpha Numeric | 35 | Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206, CLABE | ||
5.10.12 | PayeeBankCity | Alpha Numeric | Not null | |||
5.10.13 | PayeeBankProvince | Alpha Numeric | ||||
5.10.14 | PayeeBankCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id | |
5.10.15 | PayeeBankPostalCode | Alpha Numeric | ||||
5.10.16 | PayeeAccountIBANNumber | Alpha Numeric | 34 | Not null | ||
5.10.17 | PayeeBankSwiftCode | Alpha Numeric | 11 | 8 or 11 Characters SWIFT Code | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | |
5.10.18 | PayeeBankRoutingType | Alpha Numeric | WIRE, SWIFT, ACH, EFT, ABA,SEPA | |||
5.10.19 | PayeeBankRoutingCode | Alpha Numeric | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | |||
5.10.20 | PayeeBankBankCode | Alpha Numeric | Required for EFT, Use this for Transit Institution ID | |||
5.10.21 | PayeeInterBankName | Alpha Numeric | 35 | Not null for wire | ||
5.10.22 | PayeeInterBankAddress1 | Alpha Numeric | 35 | |||
5.10.23 | PayeeInterBankAddress2 | Alpha Numeric | 35 | |||
5.10.24 | PayeeInterBankCity | Alpha Numeric | Not null | |||
5.10.25 | PayeeInterBankProvince | Alpha Numeric | ||||
5.10.26 | PayeeInterBankCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id | |
5.10.27 | PayeeInterBankPostalCode | Alpha Numeric | ||||
5.10.28 | PayeeInterBankRoutingCodeType | 10 | Can be Null if Inter Bank information is not available | Swift, Wire, ABA, EFT | ||
5.10.29 | PayeeInterBankRoutingCode | Alpha Numeric | 9 | Not null if Inter Bank is present | ||
5.10.30 | PayeeInterBankBankCode | Alpha Numeric | Required for EFT, Use this for Transit Institution ID | |||
5.10.31 | PayeeReference | Alpha Numeric | 500 | |||
5.10.32 | PayeeEmail | Valid email id format Nullable | ||||
5.10.33 | OriginatorID | Alpha Numeric | ORG ID | If valid org id (of your customer) is provided, no other info is required. The relevant info will be auto populated. | ||
5.10.34 | OriginatorName | Alpha Numeric | 35 | not null | ||
5.10.35 | OriginatorAddress1 | Alpha Numeric | 35 | Not null, No P.O.Box | ||
5.10.36 | OriginatorAddress2 | Alpha Numeric | 35 | |||
5.10.37 | OriginatorCity | Alpha Numeric | Not null | |||
5.10.38 | OriginatorProvince | Alpha Numeric | Not null | |||
5.10.39 | OriginatorCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id | |
5.10.40 | OriginatorPostalCode | Alpha Numeric | ||||
5.10.41 | OriginatorType | Enum | 1 | Consumer = 0 and Business =1 | 1 = Consumer or 2 = Business | |
5.10.42 | OriginatorAccountNumber | Alpha Numeric | 34 | Not null | ||
5.10.43 | PayeeSendingBankInstructions | Alpha Numeric | 2000 | Tax ID 1234 or Contact Name: JinXiajuan | Put all additional info in this field. No special characters |
Response
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description | |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Same as in Request | Constant | |
2 | TotalNumberOfPayment | Integer | 5 |
| Not null | ||
3 | DealID | Alpha Numeric | 15 |
|
|
| |
6 | All other object info provided in Request |
| |||||
3 | TotalSettlementAmount | Number | 15,9 |
|
| ||
7 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure | |
8 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Not null | Customer id of BB site |
2 | MethodID | Alpha Numeric | 10 | AFXEWSSD | Not null | Constant
|
3 | QuoteID | Alpha Numeric | 15 |
|
| Not Required |
4 | TotalNumberOfPayment | Integer | 5 |
| Not null | Provide the number of payments in the given deal |
5 | DealDetail | ArrayOfPaymentDetails |
|
|
|
|
5.1 | PaymentSequenceNo | Integer | 5 |
| Not null | Sequence the payments |
5.2 | Direction – Buy/Sell | Enum | 4 | Buy =0 and Sell =1 | Not null | Customer stand point |
5.3 | PaymentMethod | Char |
| For Buy –Wire,ACH,EFT , For Sell –Wire,Cheque, ACHDebit, PAD | Not null |
|
5.4 | FX Currency ID | Char |
| 3 Letter ISO Code | Not null, valid currency id | |
5.5 | FX Amount | Number | 15,9 |
| 5.4 OR 5.5 Not null, greater than zero | |
5.6 | Settlement Amount | Number | 15,9 |
| Not Required | |
5.7 | Settlement Currency ID | Char | 3 | 3 Letter ISO Code | Not null, valid currency id | |
5.8 | Rate | Number | 15,9 |
| Not Required | |
5.9 | Fee | Number | 15,9 |
| Not Required | |
5.10 | TotalSettlementAmount | Number | 15,9 |
| Not Required | |
5.11 | NotesToPayee | Alpha Numeric | 500 |
|
|
|
5.12 | InternalNotes | Alpha Numeric | 500 |
|
|
|
5.13 | YourPaymentId | Alpha Numeric | 100 |
|
|
|
5.14 | Payee | Payee object |
|
|
|
|
5. 14.1 | PayeeName | Alpha Numeric | 35 |
| Not null |
|
5. 14.2 | PayeeID | Number |
|
|
| Not required any other payee info if valid payee id provided |
5. 14.3 | PayeeAddress1 | Alpha Numeric | 35 |
| Not null |
|
5. 14.4 | PayeeAddress2 | Alpha Numeric | 35 |
| Null allowed |
|
5. 14.5 | PayeeCity | Alpha Numeric | 100
|
| Not null |
|
5. 14.6 | PayeeProvince | Alpha Numeric |
|
|
|
|
5. 14.7 | PayeeCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id | |
5. 14.8 | PayeePostalCode | Alpha Numeric |
|
|
|
|
5. 14.9 | PayeeBankName | Alpha Numeric | 35 |
|
|
|
5.14.10 | PayeeBankAddress1 | Alpha Numeric | 35 |
|
|
|
5.14.11 | PayeeBankAddress2 | Alpha Numeric | 35 |
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206, CLABE 123456789 |
|
5.14.12 | PayeeBankCity | Alpha Numeric |
|
| Not null |
|
5.14.13 | PayeeBankProvince | Alpha Numeric |
|
|
|
|
5.14.14 | PayeeBankCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id | |
5.14.15 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
|
5.14.16 | PayeeAccountIBANNumber | Alpha Numeric | 34 |
| Not null |
|
5.14.17 | PayeeBankSwiftCode | Alpha Numeric | 11 | 8 or 11 Characters SWIFT Code | Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
5.14.18 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
|
5.14.19 | PayeeBankRoutingCode | Alpha Numeric |
|
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
5.14.20 | PayeeBankBankCode | Alpha Numeric |
|
| Required for EFT, Use this for Transit Institution ID |
|
5.14.21 | PayeeInterBankName | Alpha Numeric | 35 |
| Not null for wire |
|
5.14.22 | PayeeInterBankAddress1 | Alpha Numeric | 35 |
|
|
|
5.14.23 | PayeeInterBankAddress2 | Alpha Numeric | 35 |
|
|
|
5.14.24 | PayeeInterBankCity | Alpha Numeric |
|
| Not null |
|
5.14.25 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
|
5.14.26 | PayeeInterBankCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id | |
5.14.27 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
|
5.14.28 | PayeeInterBankRoutingCodeType |
| 10 |
| Can be Null if Inter Bank information is not available | Swift, Wire, ABA, EFT |
5.14.29 | PayeeInterBankRoutingCode | Alpha Numeric | 9 |
| Not null if Inter Bank is present |
|
5.14.30 | PayeeInterBankBankCode | Alpha Numeric |
|
| Required for EFT, Use this for Transit Institution ID |
|
5.14.31 | PayeeReference | Alpha Numeric | 500 |
|
|
|
5.14.32 | PayeeEmail |
|
|
| Valid email id format Nullable |
|
5.14.33 | OriginatorID | Alpha Numeric |
|
ORG ID | If valid org id (of your customer) is provided, no other info is required. The relevant info will be auto populated. | |
5.14.34 | OriginatorName | Alpha Numeric | 35 |
| Not null |
|
5.14.35 | OriginatorAddress1 | Alpha Numeric | 35 |
| Not null, No P.O.Box | |
5.14.36 | OriginatorAddress2 | Alpha Numeric | 35 |
|
|
|
5.14.37 | OriginatorCity | Alpha Numeric |
|
| Not null |
|
5.14.38 | OriginatorProvince | Alpha Numeric |
|
| Not null |
|
5.14.39 | OriginatorCountryID | Char | 2 | 2 Letter ISO Code | Not null, valid country id | |
5.14.40 | OriginatorPostalCode | Alpha Numeric |
|
|
|
|
5.14.41 | OriginatorType | Enum | 1 | Consumer =0 and Business =1 |
| |
5.14.42 | OriginatorAccountNumber | Alpha Numeric | 34 |
| Not null |
|
5.14.43 | PayeeSendingBankInstructions | Alpha Numeric | 2000 |
| Tax ID 1234 or Contact Name: JinXiajuan | Put all additional info in this field. No special characters |
Payee Information (Below Section 5.10 to 5.10.43) IS REQUIRED ONLY when Direction = Buy (Outgoing Payments).For Direction = Sell (Incoming Payments), leave them empty.
\nSee appendix for samples on swift and routing code entries
\nField Value Validation: following literals are not allowed in any payee field
\"none\", \"xml\", \"html\", \"xxx\", \"xxxx\", \"xxxxxx\", \"xx\", \"x\", \"unknown\", \"P O BOX\", \"P OBOX\", \"P O BOX\", \"PO BOX\", \"p o box\", \"p obox\", \"p o box\", \"po box\", \"POBOX\", \"pobox\".
This method will decline a response if the account is not cleared by compliance. Message provided = \" Validation Error- Client is not allowed to transact\"
\nResponse
\nSr.No | Attributes | Data Type | Data Length (Max) | Value | Validation | Note |
1 | OrgID | Alpha Numeric | 15 | Will be provided | Same as in Request | Constant |
2 | TotalNumberOfPayment | Integer | 5 |
| Not null | |
3 | DealID | Alpha Numeric | 15 |
|
|
|
4 | ErrorCode | Number | 15 | 0, 1 |
| 0 = Success; 1 = Failure |
5 | ErrorMessage | Alpha Numeric | 100 |
|
| Details of the failure |
6 | All other object info provided in Request |
|
|
|
|
|
SubmitDealAutoQuote is used to submit a Deal without the need to request and approve the foreign exchange rate. Quote will be created and accepted automatically when SubmitDealAutoQuote API call is submitted.
\nYou can also use SubmitDealAutoQuote with manually created Quotes via GetQuote API.
\nIn this case you will need to accept the Quote and make sure the data below contained in SubmitDealAutoQuote matches the Quote data:
\nDirection
\nPaymentMethod
\nFXCurrencyID
\nFXAmount
\nSettlementCurrencyID
\nSettlementAmount
\nYou have an option to specify Deal direction via Direction property:
\n0 - Buy (Funds transferred TO specified Payee/Payor)
\n1 - Sell (Funds charged FROM specified Payee/Payor)
\nThis API uses your Default Holding Account as Settlement Account. If you need the ability to provide specific Settlement Account for each Deal use SubmitDealAutoQuote_0_0_4 API call.
\nYou have 2 options to specify Payee/Payor data:
\nIF Payee/Payor already exists within Ascendant platform - provide Payee/Payor ID via PayeeID property in API
\nIF Payee/Payor doesn’t exists within Ascendant platform - provide all required properties for PayeeDetail object in API
\nYou can provide Originator data in 2 ways:
\nProvide only OriginatorID property and the system will pick up all other data from the System
\nProvide all Originator data in API without need to specify OriginatorID
\nWhen SubmitDealAutoQuote is submitted with Direction = 0 for non-existing user, Ascendant system will automatically create Payee with provided data in API with the following specifics:
\nPayment Method = PayeeBankRoutingType value
\nCurrency = FXCurrencyID value
\nNickname = Null
\nInternal Reference = PayeeName value
\nPayeeID = Auto-generated value
\nRequest
\nSr.No. | Attributes
| Data Type | Data Length (Max) | Value | Validation | Description
|
1 | OrgID | Alpha Numeric |
| Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
| AFXEWSPDC | Not null | Constant |
Response
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Description | ||
1 | ErrorCode | Integer |
|
| 0 = Success; 1 = Failure | ||
2 | ErrorMessage | Alpha Numeric |
|
| Error message | ||
3 | NumberOfAccount | Integer |
| Control number indicating number | Control number indicating number of accounts in the array | ||
4 | Account | Array OfAccountDetails |
| An Array of Account Details with | An Array of Account Details with Account Name and Balance | ||
4.1 | AccountNumber | Alpha Numeric |
|
| |||
4.2 | AccountCurrencyID |
|
| Like CAD,USD | |||
4.3 | BalanceAmount | Number | 15,9 |
|
Request
\nSr.No. | Attributes
| Data Type | Data Length (Max) | Value | Validation | Description
|
1 | OrgID | Alpha Numeric |
| Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
| AFXEWSPDC | Not null | Constant |
3 | AccountNumber | Alpha Numeric | Not null | Same as provided in GetAccountBalanceResponse -> Account ->AccountNumber | ||
4 | Factor | Integer | 0,1,2,3 | Not null | 0 with no month and year->Will get current month activity 0 with year and month -> will get that specific month activity 1 – will get start to current month activity 2 Specific month to current month 3 Start to specific month | |
5 | Month | Integer | 1 to 12 | |||
6 | Year | Integer | 1900 to 2099 |
Response
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Description | ||||
1 | ErrorCode | Integer |
|
| 0 = Success; 1 = Failure | ||||
2 | ErrorMessage | Alpha Numeric |
|
| Error message | ||||
3 | NumberOfTransaction | Integer |
| Control number indicating | |||||
4 | AccountNumber | Same as in request | |||||||
5 | OpeningBalance | Decimal | 15,9 |
| |||||
6 | ClosingBalance | Decimal | 15,9 | ||||||
7 | Factor | Integer | Same as in request |
| |||||
8 | Month | Integer | Same as in request | ||||||
9 | Year | Integer | Same as in request | ||||||
10 | Transaction | Array of TransactionDetails | |||||||
10.1 | TransactionSequenceNo | Integer | |||||||
10.2 | TransactionDate | date | |||||||
10.3 | Withdrawal | Decimal | 15,9 | ||||||
10.4 | Deposit | Decimal | 15,9 | ||||||
10.5 | Narration | Alpha Numeric | |||||||
10.6 | Balance | Decimal | 15,9 |
Request
\nSr.No. | Attributes
| Data Type | Data Length (Max) | Value | Validation | Description
|
1 | OrgID | Alpha Numeric |
| Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
| AFXEWSPDC | Not null | Constant |
3 | AccountNumber | Alpha Numeric | Not null | Same as provided in GetAccountBalanceResponse -> Account ->AccountNumber | ||
4 | Factor | Integer | 0,1,2,3 | Not null | 0 with no month and year->Will get current month activity 0 with year and month -> will get that specific month activity 1 – will get start to current month activity 2 Specific month to current month 3 Start to specific month | |
5 | Month | Integer | 1 to 12 | |||
6 | Year | Integer | 1900 to 2099 | |||
7 | Days | Integer | 1 to N Nmax = 30 | 15 | 1 - Records from Today 2 – Today and Yesterday 3 - Today, Yesterday and the Day Before N – Last N days | |
8 | DealId | Alpha numeric | Nullable | Wild card-based search Acceptable formats: a. AFX US-DEAL-123456 b. 123456 | ||
9 | TransactionType | Integer | 0 to 2 | Not null | 0 – will get both Credit and Debit records 1 – will get all Credit records 2 – will get all Debit records |
Response
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Description | ||||
1 | ErrorCode | Integer |
|
| 0 = Success; 1 = Failure | ||||
2 | ErrorMessage | Alpha Numeric |
|
| Error message | ||||
3 | NumberOfTransaction | Integer |
| Control number indicating | |||||
4 | AccountNumber | Alpha Numeric | Same as in request | ||||||
5 | Days | Integer | Same as in request | ||||||
5 | DealId | Alpha Numeric |
| Same as in request |
| ||||
7 | Factor | Integer | Same as in request |
| |||||
8 | Month | Integer | Same as in request | ||||||
9 | Year | Integer | Same as in request | ||||||
10 | TransactionType | Integer | Same as in request | ||||||
10 | Transaction | Array of TransactionDetails_0_0_1 | |||||||
10.1 | TransactionSequenceNo | Integer | |||||||
10.2 | TransactionDate | date | |||||||
10.3 | Withdrawal | Decimal | 15,9 | ||||||
10.4 | Deposit | Decimal | 15,9 | ||||||
10.5 | Narration | Alpha Numeric | |||||||
10.6 | DealId | Alpha Numeric | Two Formats Possible (Sample) Values. Response will be in one of the two format c. AFX US-DEAL -123456 d. 576918 | ||||||
10.7 | TransactionType | Alpha Numeric |
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric |
| Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
| AFXEWSPD | Not null | Constant |
Response
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Description |
1 | ErrorCode | Integer |
|
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric |
|
| Error message |
3 | DealPostCallID | Integer |
|
| A unique will be return per successful call for post confirmation call reference |
4 | NumberOfDeals | Integer |
|
| Control number indicating number of deals in the array |
5 | Deals | Array Of DealDetails |
|
| An Array of Deal Details with deal number and amount |
5.1 | CallDateTime | datetime |
|
|
|
5.2 | OrgID |
| 15,9 |
|
|
5.3 | InitiatedBy | Alpha Numeric |
|
|
|
5.4 | ApprovedBy | Alpha Numeric |
|
|
|
5.5 | AFXDealID | Alpha Numeric |
|
|
|
5.6 | AFXPaymentID | Alpha Numeric |
|
|
|
5.7 | TransactionDate | datetime |
|
|
|
5.8 | FXAmount | Number | 15,9 |
|
|
5.9 | FXCurrencyID | Alpha Numeric |
|
|
|
5.10 | DebitAmount | Number |
|
|
|
5.11 | SettlementCurrencyID | Alpha Numeric |
|
|
|
5.12 | PaymentReference | Alpha Numeric |
|
|
|
5.13 | YourInternalReference | Alpha Numeric |
|
|
|
Request
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric |
| Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
| AFXEWSPD | Not null | Constant |
Response
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Description |
1 | ErrorCode | Integer |
|
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric |
|
| Error message |
3 | DealPostCallID | Integer |
|
| A unique will be return per successful call for post confirmation call reference |
4 | NumberOfDeals | Integer |
|
| Control number indicating number of deals in the array |
5 | Deals | Array Of DealDetails_0_0_1 |
|
| An Array of Deal Details with deal number and amount |
5.1 | CallDateTime | datetime |
|
|
|
5.2 | OrgID |
| 15,9 |
|
|
5.3 | InitiatedBy | Alpha Numeric |
|
|
|
5.4 | ApprovedBy | Alpha Numeric |
|
|
|
5.5 | AFXDealID | Alpha Numeric |
|
|
|
5.6 | AFXPaymentID | Alpha Numeric |
|
|
|
5.7 | TransactionDate | datetime |
|
|
|
5.8 | FXAmount | Number | 15,9 |
|
|
5.9 | Rate | Number | |||
5.10 | FXCurrencyID | Alpha Numeric |
|
|
|
5.11 | DebitAmount | Number |
|
|
|
5.12 | SettlementCurrencyID | Alpha Numeric |
|
|
|
5.13 | PaymentReference | Alpha Numeric |
|
|
|
5.14 | YourInternalReference | Alpha Numeric |
|
|
|
This version of Post Deal includes rate, fee, remitter name/originator name/by order of name in the response.
\nRequest
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Validation | Description |
1 | OrgID | Alpha Numeric |
| Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
| AFXEWSPD | Not null | Constant |
Response
\nSr.No. | Attributes | Data Type | Data Length (Max) | Value | Description |
1 | ErrorCode | Integer |
|
| 0 = Success; 1 = Failure |
2 | ErrorMessage | Alpha Numeric |
|
| Error message |
3 | DealPostCallID | Integer |
|
| A unique will be return per successful call for post confirmation call reference |
4 | NumberOfDeals | Integer |
|
| Control number indicating number of deals in the array |
5 | Deals | Array Of DealDetails_0_0_2 |
|
| An Array of Deal Details with deal number and amount |
5.1 | CallDateTime | datetime |
|
|
|
5.2 | OrgID |
| 15,9 |
|
|
5.3 | InitiatedBy | Alpha Numeric |
|
|
|
5.4 | ApprovedBy | Alpha Numeric |
|
|
|
5.5 | AFXDealID | Alpha Numeric |
|
|
|
5.6 | AFXPaymentID | Alpha Numeric |
|
|
|
5.7 | TransactionDate | datetime |
|
|
|
5.8 | FXAmount | Number | 15,9 |
|
|
5.9 | FXCurrencyID | Alpha Numeric |
|
|
|
5.10 | Rate | Number | 15,9 |
|
|
5.11 | DebitAmount | Number |
|
|
|
5.12 | SettlementCurrencyID | Alpha Numeric |
|
|
|
5.13 | PaymentReference | Alpha Numeric |
|
|
|
5.14 | YourInternalReference | Alpha Numeric |
|
|
|
5.15 | Fee | Number | 15,9 |
|
|
5.16 | OriginatorName | Alpha Numeric |
|
|
|
Request
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
AFXEWSPOA |
Constant | |
3 | PayeeDetail | PayeeDetail |
| not null | [Single Node Here] |
3.1 | PayeeID | Alpha Numeric | Set 0 for add payee | Not null |
|
3.2 | PayeeName | Alpha Numeric |
| Not null |
|
3.3 | CurrencyID | Char | 3 Letter ISO Code | Not null | valid currency id |
3.4 | PaymentMethod | Char | Wire, Draft | Not null |
|
3.5 | PayeeAddress1 | Alpha Numeric |
|
| |
3.6 | PayeeAddress2 | Alpha Numeric |
|
| |
3.7 | PayeeCity | Alpha Numeric |
|
| |
3.8 | PayeeProvince | Alpha Numeric |
|
| |
3.9 | PayeeCountryID | Char | 2 Letter ISO Code |
|
|
3.10 | PayeePostalCode | Alpha Numeric |
|
|
|
3.11 | PayeeBankName | Alpha Numeric |
| Not null |
|
3.12 | PayeeBankAddress1 | Alpha Numeric |
|
|
|
3.13 | PayeeBankAddress2 | Alpha Numeric |
|
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206 |
3.14 | PayeeBankCity | Alpha Numeric |
|
|
|
3.15 | PayeeBankProvince | Alpha Numeric |
|
|
|
3.16 | PayeeBankCountryID | Char | 2 Letter ISO Code | Not null, valid country id | |
3.17 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
3.18 | PayeeAccountIBANNumber | Alpha Numeric |
|
|
|
3.19 | PayeeBankSwiftCode | Alpha Numeric | SBIN1556XXX | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | Includes 3 letter swift branch code; 11 characters |
3.20 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
3.21 | PayeeBankRoutingCode | Alpha Numeric |
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
3.22 | PayeeBankBankCode | Alpha Numeric |
|
|
|
3.23 | PayeeInterBankName | Alpha Numeric | |||
3.24 | PayeeInterBankAddress1 | Alpha Numeric | |||
3.25 | PayeeInterBankAddress2 | Alpha Numeric |
|
|
|
3.26 | PayeeInterBankCity | Alpha Numeric |
|
| |
3.27 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
3.28 | PayeeInterBankCountryID | Char | 2 Letter ISO Code |
| valid country id |
3.29 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
3.30 | PayeeInterBankRoutingCodeType | Alpha Numeric |
| Not null if Inter Bank is present | Swift/ABA |
3.31 | PayeeInterBankRoutingCode | Alpha Numeric |
| Not null if Inter Bank is present | Max 8 for swift, 9 for ABA |
3.32 | PayeeInterBankBankCode | Alpha Numeric |
|
|
|
3.33 | PayeeReference | Alpha Numeric |
|
|
|
3.34 | PayeeEmail | Alpha Numeric |
| Valid email id format Nullable |
|
3.35 | OriginatorID | Alpha Numeric |
|
| If valid org id is provided, no other info is required. The relevant info will be auto populated. |
3.36 | OriginatorName | Alpha Numeric |
|
|
|
3.37 | OriginatorAddress1 | Alpha Numeric |
|
| |
3.38 | OriginatorAddress2 | Alpha Numeric |
|
|
|
3.39 | OriginatorCity | Alpha Numeric |
|
|
|
3.40 | OriginatorProvince | Alpha Numeric |
|
|
|
3.41 | OriginatorCountryID | Char | 2 Letter ISO Code |
|
|
3.42 | OriginatorType | Enum | Consumer=0 and Buisness = 1 |
| |
3.43 | OriginatorAccountNumber | Alpha Numeric |
|
|
|
3.44 | PayeeInternalReference | Alpha Numeric | This can be internal id or reference of integrator database |
|
|
3.45 | PayeeSendingBankInstructions | Alpha Numeric |
| Max 200 character | Tax ID, Contact Name,Contact Phone |
Response
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | Error Code | Integer | Not null | 0 = Success; 1 = Failure | |
2 | Error Message | Alpha Numeric |
| Error message | |
3 | Number Of Payees | Alpha Numeric | |||
4 | PayeeDetail | PayeeDetail |
| not null | [Single Node Here] |
4.1 | PayeeID | Alpha Numeric | Set 0 for add payee | Not null |
|
3.2 | PayeeName | Alpha Numeric |
| Not null |
|
3.3 | CurrencyID | Char | 3 Letter ISO Code | Not null | valid currency id |
3.4 | PaymentMethod | Char | Wire, Draft | Not null |
|
3.5 | PayeeAddress1 | Alpha Numeric |
|
| |
3.6 | PayeeAddress2 | Alpha Numeric |
|
| |
3.7 | PayeeCity | Alpha Numeric |
|
| |
3.8 | PayeeProvince | Alpha Numeric |
|
| |
3.9 | PayeeCountryID | Char | 2 Letter ISO Code |
|
|
3.10 | PayeePostalCode | Alpha Numeric |
|
|
|
3.11 | PayeeBankName | Alpha Numeric |
| Not null |
|
3.12 | PayeeBankAddress1 | Alpha Numeric |
|
|
|
3.13 | PayeeBankAddress2 | Alpha Numeric |
|
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206 |
3.14 | PayeeBankCity | Alpha Numeric |
|
|
|
3.15 | PayeeBankProvince | Alpha Numeric |
|
|
|
3.16 | PayeeBankCountryID | Char | 2 Letter ISO Code | Not null, valid country id | |
3.17 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
3.18 | PayeeAccountIBANNumber | Alpha Numeric |
|
|
|
3.19 | PayeeBankSwiftCode | Alpha Numeric | SBIN1556XXX | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | Includes 3 letter swift branch code; 11 characters |
3.20 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
3.21 | PayeeBankRoutingCode | Alpha Numeric |
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
3.22 | PayeeBankBankCode | Alpha Numeric |
|
|
|
3.23 | PayeeInterBankName | Alpha Numeric | |||
3.24 | PayeeInterBankAddress1 | Alpha Numeric | |||
3.25 | PayeeInterBankAddress2 | Alpha Numeric |
|
|
|
3.26 | PayeeInterBankCity | Alpha Numeric |
|
| |
3.27 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
3.28 | PayeeInterBankCountryID | Char | 2 Letter ISO Code |
| valid country id |
3.29 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
3.30 | PayeeInterBankRoutingCodeType | Alpha Numeric |
| Not null if Inter Bank is present | Swift/ABA |
3.31 | PayeeInterBankRoutingCode | Alpha Numeric |
| Not null if Inter Bank is present | Max 8 for swift, 9 for ABA |
3.32 | PayeeInterBankBankCode | Alpha Numeric |
|
|
|
3.33 | PayeeReference | Alpha Numeric |
|
|
|
3.34 | PayeeEmail | Alpha Numeric |
| Valid email id format Nullable |
|
3.35 | OriginatorID | Alpha Numeric |
|
| If valid org id is provided, no other info is required. The relevant info will be auto populated. |
3.36 | OriginatorName | Alpha Numeric |
|
|
|
3.37 | OriginatorAddress1 | Alpha Numeric |
|
| |
3.38 | OriginatorAddress2 | Alpha Numeric |
|
|
|
3.39 | OriginatorCity | Alpha Numeric |
|
|
|
3.40 | OriginatorProvince | Alpha Numeric |
|
|
|
3.41 | OriginatorCountryID | Char | 2 Letter ISO Code |
|
|
3.42 | OriginatorType | Enum | Consumer=0 and Buisness = 1 |
| |
3.43 | OriginatorAccountNumber | Alpha Numeric |
|
|
|
3.44 | PayeeInternalReference | Alpha Numeric | This can be internal id or reference of integrator database |
|
|
3.45 | PayeeSendingBankInstructions | Alpha Numeric |
| Max 200 character | Tax ID, Contact Name,Contact Phone |
Request
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
AFXEWSPOA |
Constant | |
3 | PayeeDetail | PayeeDetail |
| not null | [Single Node Here] |
3.1 | PayeeID | Alpha Numeric | Set 0 for add payee | Not null |
|
3.2 | PayeeName | Alpha Numeric |
| Not null |
|
3.3 | CurrencyID | Char | 3 Letter ISO Code | Not null | valid currency id |
3.4 | PaymentMethod | Char | Wire, Draft | Not null |
|
3.5 | PayeeAddress1 | Alpha Numeric |
|
| |
3.6 | PayeeAddress2 | Alpha Numeric |
|
| |
3.7 | PayeeCity | Alpha Numeric |
|
| |
3.8 | PayeeProvince | Alpha Numeric |
|
| |
3.9 | PayeeCountryID | Char | 2 Letter ISO Code |
|
|
3.10 | PayeePostalCode | Alpha Numeric |
|
|
|
3.11 | PayeeBankName | Alpha Numeric |
| Not null |
|
3.12 | PayeeBankAddress1 | Alpha Numeric |
|
|
|
3.13 | PayeeBankAddress2 | Alpha Numeric |
|
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206 |
3.14 | PayeeBankCity | Alpha Numeric |
|
|
|
3.15 | PayeeBankProvince | Alpha Numeric |
|
|
|
3.16 | PayeeBankCountryID | Char | 2 Letter ISO Code | Not null, valid country id | |
3.17 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
3.18 | PayeeAccountIBANNumber | Alpha Numeric |
|
|
|
3.19 | PayeeBankSwiftCode | Alpha Numeric | SBIN1556XXX | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | Includes 3 letter swift branch code; 11 characters |
3.20 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
3.21 | PayeeBankRoutingCode | Alpha Numeric |
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
3.22 | PayeeBankBankCode | Alpha Numeric |
|
|
|
3.23 | PayeeInterBankName | Alpha Numeric | |||
3.24 | PayeeInterBankAddress1 | Alpha Numeric | |||
3.25 | PayeeInterBankAddress2 | Alpha Numeric |
|
|
|
3.26 | PayeeInterBankCity | Alpha Numeric |
|
| |
3.27 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
3.28 | PayeeInterBankCountryID | Char | 2 Letter ISO Code |
| valid country id |
3.29 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
3.30 | PayeeInterBankRoutingCodeType | Alpha Numeric |
| Not null if Inter Bank is present | Swift/ABA |
3.31 | PayeeInterBankRoutingCode | Alpha Numeric |
| Not null if Inter Bank is present | Max 8 for swift, 9 for ABA |
3.32 | PayeeInterBankBankCode | Alpha Numeric |
|
|
|
3.33 | PayeeReference | Alpha Numeric |
|
|
|
3.34 | PayeeEmail | Alpha Numeric |
| Valid email id format Nullable |
|
3.35 | OriginatorID | Alpha Numeric |
|
| If valid org id is provided, no other info is required. The relevant info will be auto populated. |
3.36 | OriginatorName | Alpha Numeric |
|
|
|
3.37 | OriginatorAddress1 | Alpha Numeric |
|
| |
3.38 | OriginatorAddress2 | Alpha Numeric |
|
|
|
3.39 | OriginatorCity | Alpha Numeric |
|
|
|
3.40 | OriginatorProvince | Alpha Numeric |
|
|
|
3.41 | OriginatorCountryID | Char | 2 Letter ISO Code |
|
|
3.42 | OriginatorType | Enum | Consumer=0 and Buisness = 1 |
| |
3.43 | OriginatorAccountNumber | Alpha Numeric |
|
|
|
3.44 | PayeeInternalReference | Alpha Numeric | This can be internal id or reference of integrator database |
|
|
3.45 | PayeeSendingBankInstructions | Alpha Numeric |
| Max 200 character | Tax ID, Contact Name,Contact Phone |
Response
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | Error Code | Integer | Not null | 0 = Success; 1 = Failure | |
2 | Error Message | Alpha Numeric |
| Error message | |
3 | Number Of Payees | Alpha Numeric | |||
4 | PayeeDetail | PayeeDetail |
| not null | [Single Node Here] |
4.1 | PayeeID | Alpha Numeric | Set 0 for add payee | Not null |
|
3.2 | PayeeName | Alpha Numeric |
| Not null |
|
3.3 | CurrencyID | Char | 3 Letter ISO Code | Not null | valid currency id |
3.4 | PaymentMethod | Char | Wire, Draft | Not null |
|
3.5 | PayeeAddress1 | Alpha Numeric |
|
| |
3.6 | PayeeAddress2 | Alpha Numeric |
|
| |
3.7 | PayeeCity | Alpha Numeric |
|
| |
3.8 | PayeeProvince | Alpha Numeric |
|
| |
3.9 | PayeeCountryID | Char | 2 Letter ISO Code |
|
|
3.10 | PayeePostalCode | Alpha Numeric |
|
|
|
3.11 | PayeeBankName | Alpha Numeric |
| Not null |
|
3.12 | PayeeBankAddress1 | Alpha Numeric |
|
|
|
3.13 | PayeeBankAddress2 | Alpha Numeric |
|
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206 |
3.14 | PayeeBankCity | Alpha Numeric |
|
|
|
3.15 | PayeeBankProvince | Alpha Numeric |
|
|
|
3.16 | PayeeBankCountryID | Char | 2 Letter ISO Code | Not null, valid country id | |
3.17 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
3.18 | PayeeAccountIBANNumber | Alpha Numeric |
|
|
|
3.19 | PayeeBankSwiftCode | Alpha Numeric | SBIN1556XXX | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | Includes 3 letter swift branch code; 11 characters |
3.20 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
3.21 | PayeeBankRoutingCode | Alpha Numeric |
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
3.22 | PayeeBankBankCode | Alpha Numeric |
|
|
|
3.23 | PayeeInterBankName | Alpha Numeric | |||
3.24 | PayeeInterBankAddress1 | Alpha Numeric | |||
3.25 | PayeeInterBankAddress2 | Alpha Numeric |
|
|
|
3.26 | PayeeInterBankCity | Alpha Numeric |
|
| |
3.27 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
3.28 | PayeeInterBankCountryID | Char | 2 Letter ISO Code |
| valid country id |
3.29 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
3.30 | PayeeInterBankRoutingCodeType | Alpha Numeric |
| Not null if Inter Bank is present | Swift/ABA |
3.31 | PayeeInterBankRoutingCode | Alpha Numeric |
| Not null if Inter Bank is present | Max 8 for swift, 9 for ABA |
3.32 | PayeeInterBankBankCode | Alpha Numeric |
|
|
|
3.33 | PayeeReference | Alpha Numeric |
|
|
|
3.34 | PayeeEmail | Alpha Numeric |
| Valid email id format Nullable |
|
3.35 | OriginatorID | Alpha Numeric |
|
| If valid org id is provided, no other info is required. The relevant info will be auto populated. |
3.36 | OriginatorName | Alpha Numeric |
|
|
|
3.37 | OriginatorAddress1 | Alpha Numeric |
|
| |
3.38 | OriginatorAddress2 | Alpha Numeric |
|
|
|
3.39 | OriginatorCity | Alpha Numeric |
|
|
|
3.40 | OriginatorProvince | Alpha Numeric |
|
|
|
3.41 | OriginatorCountryID | Char | 2 Letter ISO Code |
|
|
3.42 | OriginatorType | Enum | Consumer=0 and Buisness = 1 |
| |
3.43 | OriginatorAccountNumber | Alpha Numeric |
|
|
|
3.44 | PayeeInternalReference | Alpha Numeric | This can be internal id or reference of integrator database |
|
|
3.45 | PayeeSendingBankInstructions | Alpha Numeric |
| Max 200 character | Tax ID, Contact Name,Contact Phone |
Request
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
AFXEWSPOA |
Constant | |
3 | PayeeDetail | PayeeDetail |
| not null | [Single Node Here] |
3.1 | PayeeID | Alpha Numeric | Set 0 for add payee | Not null |
|
3.2 | PayeeName | Alpha Numeric |
| Not null |
|
3.3 | PayeeNickname | AlphaNumeric | |||
3.4 | CurrencyID | Char | 3 Letter ISO Code | Not null | valid currency id |
3.5 | PaymentMethod | Char | Wire, Draft | Not null |
|
3.6 | PayeeAddress1 | Alpha Numeric |
|
| |
3.7 | PayeeAddress2 | Alpha Numeric |
|
| |
3.8 | PayeeCity | Alpha Numeric |
|
| |
3.9 | PayeeProvince | Alpha Numeric |
|
| |
3.10 | PayeeCountryID | Char | 2 Letter ISO Code |
|
|
3.11 | PayeePostalCode | Alpha Numeric |
|
|
|
3.12 | PayeeBankName | Alpha Numeric |
| Not null |
|
3.13 | PayeeBankAddress1 | Alpha Numeric |
|
|
|
3.14 | PayeeBankAddress2 | Alpha Numeric |
|
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206 |
3.15 | PayeeBankCity | Alpha Numeric |
|
|
|
3.16 | PayeeBankProvince | Alpha Numeric |
|
|
|
3.17 | PayeeBankCountryID | Char | 2 Letter ISO Code | Not null, valid country id | |
3.18 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
3.19 | PayeeAccountIBANNumber | Alpha Numeric |
|
|
|
3.20 | PayeeBankSwiftCode | Alpha Numeric | SBIN1556XXX | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | Includes 3 letter swift branch code; 11 characters |
3.21 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
3.22 | PayeeBankRoutingCode | Alpha Numeric |
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
3.23 | PayeeBankBankCode | Alpha Numeric |
|
|
|
3.24 | PayeeInterBankName | Alpha Numeric | |||
3.25 | PayeeInterBankAddress1 | Alpha Numeric | |||
3.26 | PayeeInterBankAddress2 | Alpha Numeric |
|
|
|
3.27 | PayeeInterBankCity | Alpha Numeric |
|
| |
3.28 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
3.29 | PayeeInterBankCountryID | Char | 2 Letter ISO Code |
| valid country id |
3.30 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
3.31 | PayeeInterBankRoutingCodeType | Alpha Numeric |
| Not null if Inter Bank is present | Swift/ABA |
3.32 | PayeeInterBankRoutingCode | Alpha Numeric |
| Not null if Inter Bank is present | Max 8 for swift, 9 for ABA |
3.33 | PayeeInterBankBankCode | Alpha Numeric |
|
|
|
3.34 | PayeeReference | Alpha Numeric |
|
|
|
3.35 | PayeeEmail | Alpha Numeric |
| Valid email id format Nullable |
|
3.36 | OriginatorID | Alpha Numeric |
|
| If valid org id is provided, no other info is required. The relevant info will be auto populated. |
3.37 | OriginatorName | Alpha Numeric |
|
|
|
3.38 | OriginatorAddress1 | Alpha Numeric |
|
| |
3.39 | OriginatorAddress2 | Alpha Numeric |
|
|
|
3.40 | OriginatorCity | Alpha Numeric |
|
|
|
3.41 | OriginatorProvince | Alpha Numeric |
|
|
|
3.42 | OriginatorCountryID | Char | 2 Letter ISO Code |
|
|
3.43 | OriginatorType | Enum | Consumer=0 and Buisness = 1 |
| |
3.44 | OriginatorAccountNumber | Alpha Numeric |
|
|
|
3.45 | PayeeInternalReference | Alpha Numeric | This can be internal id or reference of integrator database |
|
|
3.46 | PayeeSendingBankInstructions | Alpha Numeric |
| Max 200 character | Tax ID, Contact Name,Contact Phone |
Response
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | Error Code | Integer | Not null | 0 = Success; 1 = Failure | |
2 | Error Message | Alpha Numeric |
| Error message | |
3 | Number Of Payees | Alpha Numeric | |||
4 | PayeeDetail | PayeeDetail |
| not null | [Single Node Here] |
4.1 | PayeeID | Alpha Numeric | Set 0 for add payee | Not null |
|
3.2 | PayeeName | Alpha Numeric |
| Not null |
|
3.3 | PayeeNickName | Alpha Numeric | |||
3.4 | CurrencyID | Char | 3 Letter ISO Code | Not null | valid currency id |
3.5 | PaymentMethod | Char | Wire, Draft | Not null |
|
3.6 | PayeeAddress1 | Alpha Numeric |
|
| |
3.7 | PayeeAddress2 | Alpha Numeric |
|
| |
3.8 | PayeeCity | Alpha Numeric |
|
| |
3.9 | PayeeProvince | Alpha Numeric |
|
| |
3.10 | PayeeCountryID | Char | 2 Letter ISO Code |
|
|
3.11 | PayeePostalCode | Alpha Numeric |
|
|
|
3.12 | PayeeBankName | Alpha Numeric |
| Not null |
|
3.13 | PayeeBankAddress1 | Alpha Numeric |
|
|
|
3.14 | PayeeBankAddress2 | Alpha Numeric |
|
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206 |
3.15 | PayeeBankCity | Alpha Numeric |
|
|
|
3.16 | PayeeBankProvince | Alpha Numeric |
|
|
|
3.17 | PayeeBankCountryID | Char | 2 Letter ISO Code | Not null, valid country id | |
3.18 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
3.19 | PayeeAccountIBANNumber | Alpha Numeric |
|
|
|
3.20 | PayeeBankSwiftCode | Alpha Numeric | SBIN1556XXX | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | Includes 3 letter swift branch code; 11 characters |
3.21 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
3.22 | PayeeBankRoutingCode | Alpha Numeric |
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
3.23 | PayeeBankBankCode | Alpha Numeric |
|
|
|
3.24 | PayeeInterBankName | Alpha Numeric | |||
3.25 | PayeeInterBankAddress1 | Alpha Numeric | |||
3.26 | PayeeInterBankAddress2 | Alpha Numeric |
|
|
|
3.27 | PayeeInterBankCity | Alpha Numeric |
|
| |
3.28 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
3.29 | PayeeInterBankCountryID | Char | 2 Letter ISO Code |
| valid country id |
3.30 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
3.31 | PayeeInterBankRoutingCodeType | Alpha Numeric |
| Not null if Inter Bank is present | Swift/ABA |
3.32 | PayeeInterBankRoutingCode | Alpha Numeric |
| Not null if Inter Bank is present | Max 8 for swift, 9 for ABA |
3.33 | PayeeInterBankBankCode | Alpha Numeric |
|
|
|
3.34 | PayeeReference | Alpha Numeric |
|
|
|
3.35 | PayeeEmail | Alpha Numeric |
| Valid email id format Nullable |
|
3.36 | OriginatorID | Alpha Numeric |
|
| If valid org id is provided, no other info is required. The relevant info will be auto populated. |
3.37 | OriginatorName | Alpha Numeric |
|
|
|
3.38 | OriginatorAddress1 | Alpha Numeric |
|
| |
3.39 | OriginatorAddress2 | Alpha Numeric |
|
|
|
3.40 | OriginatorCity | Alpha Numeric |
|
|
|
3.41 | OriginatorProvince | Alpha Numeric |
|
|
|
3.42 | OriginatorCountryID | Char | 2 Letter ISO Code |
|
|
3.43 | OriginatorType | Enum | Consumer=0 and Buisness = 1 |
| |
3.44 | OriginatorAccountNumber | Alpha Numeric |
|
|
|
3.45 | PayeeInternalReference | Alpha Numeric | This can be internal id or reference of integrator database |
|
|
3.46 | PayeeSendingBankInstructions | Alpha Numeric |
| Max 200 character | Tax ID, Contact Name,Contact Phone |
Request
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | OrgID | Alpha Numeric | Will be provided | Not null |
|
2 | MethodID | Alpha Numeric |
AFXEWSPOA |
Constant | |
3 | PayeeDetail | PayeeDetail |
| not null | [Single Node Here] |
3.1 | PayeeID | Alpha Numeric | Set 0 for add payee | Not null |
|
3.2 | PayeeName | Alpha Numeric |
| Not null |
|
3.3 | PayeeNickname | Alpha Numeric | |||
3.4 | CurrencyID | Char | 3 Letter ISO Code | Not null | valid currency id |
3.5 | PaymentMethod | Char | Wire, Draft | Not null |
|
3.6 | PayeeAddress1 | Alpha Numeric |
|
| |
3.7 | PayeeAddress2 | Alpha Numeric |
|
| |
3.8 | PayeeCity | Alpha Numeric |
|
| |
3.9 | PayeeProvince | Alpha Numeric |
|
| |
3.10 | PayeeCountryID | Char | 2 Letter ISO Code |
|
|
3.11 | PayeePostalCode | Alpha Numeric |
|
|
|
3.12 | PayeeBankName | Alpha Numeric |
| Not null |
|
3.13 | PayeeBankAddress1 | Alpha Numeric |
|
|
|
3.14 | PayeeBankAddress2 | Alpha Numeric |
|
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206 |
3.15 | PayeeBankCity | Alpha Numeric |
|
|
|
3.16 | PayeeBankProvince | Alpha Numeric |
|
|
|
3.17 | PayeeBankCountryID | Char | 2 Letter ISO Code | Not null, valid country id | |
3.18 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
3.19 | PayeeAccountIBANNumber | Alpha Numeric |
|
|
|
3.20 | PayeeBankSwiftCode | Alpha Numeric | SBIN1556XXX | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | Includes 3 letter swift branch code; 11 characters |
3.21 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
3.22 | PayeeBankRoutingCode | Alpha Numeric |
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
3.23 | PayeeBankBankCode | Alpha Numeric |
|
|
|
3.24 | PayeeInterBankName | Alpha Numeric | |||
3.25 | PayeeInterBankAddress1 | Alpha Numeric | |||
3.26 | PayeeInterBankAddress2 | Alpha Numeric |
|
|
|
3.27 | PayeeInterBankCity | Alpha Numeric |
|
| |
3.28 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
3.29 | PayeeInterBankCountryID | Char | 2 Letter ISO Code |
| valid country id |
3.30 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
3.31 | PayeeInterBankRoutingCodeType | Alpha Numeric |
| Not null if Inter Bank is present | Swift/ABA |
3.32 | PayeeInterBankRoutingCode | Alpha Numeric |
| Not null if Inter Bank is present | Max 8 for swift, 9 for ABA |
3.33 | PayeeInterBankBankCode | Alpha Numeric |
|
|
|
3.34 | PayeeReference | Alpha Numeric |
|
|
|
3.35 | PayeeEmail | Alpha Numeric |
| Valid email id format Nullable |
|
3.36 | OriginatorID | Alpha Numeric |
|
| If valid org id is provided, no other info is required. The relevant info will be auto populated. |
3.37 | OriginatorName | Alpha Numeric |
|
|
|
3.38 | OriginatorAddress1 | Alpha Numeric |
|
| |
3.39 | OriginatorAddress2 | Alpha Numeric |
|
|
|
3.40 | OriginatorCity | Alpha Numeric |
|
|
|
3.41 | OriginatorProvince | Alpha Numeric |
|
|
|
3.42 | OriginatorCountryID | Char | 2 Letter ISO Code |
|
|
3.43 | OriginatorType | Enum | Consumer=0 and Buisness = 1 |
| |
3.44 | OriginatorAccountNumber | Alpha Numeric |
|
|
|
3.45 | PayeeInternalReference | Alpha Numeric | This can be internal id or reference of integrator database |
|
|
3.46 | PayeeSendingBankInstructions | Alpha Numeric |
| Max 200 character | Tax ID, Contact Name,Contact Phone |
Response
\nSr.No. | Attributes | Data Type | Value | Validation | Description |
1 | Error Code | Integer | Not null | 0 = Success; 1 = Failure | |
2 | Error Message | Alpha Numeric |
| Error message | |
3 | Number Of Payees | Alpha Numeric | |||
4 | PayeeDetail | PayeeDetail |
| not null | [Single Node Here] |
4.1 | PayeeID | Alpha Numeric | Set 0 for add payee | Not null |
|
3.2 | PayeeName | Alpha Numeric |
| Not null |
|
3.3 | PayeeNickname | Alpha Numeric | |||
3.4 | CurrencyID | Char | 3 Letter ISO Code | Not null | valid currency id |
3.5 | PaymentMethod | Char | Wire, Draft | Not null |
|
3.6 | PayeeAddress1 | Alpha Numeric |
|
| |
3.7 | PayeeAddress2 | Alpha Numeric |
|
| |
3.8 | PayeeCity | Alpha Numeric |
|
| |
3.9 | PayeeProvince | Alpha Numeric |
|
| |
3.10 | PayeeCountryID | Char | 2 Letter ISO Code |
|
|
3.11 | PayeePostalCode | Alpha Numeric |
|
|
|
3.12 | PayeeBankName | Alpha Numeric |
| Not null |
|
3.13 | PayeeBankAddress1 | Alpha Numeric |
|
|
|
3.14 | PayeeBankAddress2 | Alpha Numeric |
|
| Map all routing code info in the format: BSB 033088, IFSC Code ICIC0001206 |
3.15 | PayeeBankCity | Alpha Numeric |
|
|
|
3.16 | PayeeBankProvince | Alpha Numeric |
|
|
|
3.17 | PayeeBankCountryID | Char | 2 Letter ISO Code | Not null, valid country id | |
3.18 | PayeeBankPostalCode | Alpha Numeric |
|
|
|
3.19 | PayeeAccountIBANNumber | Alpha Numeric |
|
|
|
3.20 | PayeeBankSwiftCode | Alpha Numeric | SBIN1556XXX | Either PayeeBankSwiftCode or PayeeBankRoutingCode required | Includes 3 letter swift branch code; 11 characters |
3.21 | PayeeBankRoutingType | Alpha Numeric |
| WIRE, SWIFT, ACH, EFT, ABA,SEPA |
|
3.22 | PayeeBankRoutingCode | Alpha Numeric |
| Either PayeeBankSwiftCode or PayeeBankRoutingCode required |
|
3.23 | PayeeBankBankCode | Alpha Numeric |
|
|
|
3.24 | PayeeInterBankName | Alpha Numeric | |||
3.25 | PayeeInterBankAddress1 | Alpha Numeric | |||
3.26 | PayeeInterBankAddress2 | Alpha Numeric |
|
|
|
3.27 | PayeeInterBankCity | Alpha Numeric |
|
| |
3.28 | PayeeInterBankProvince | Alpha Numeric |
|
|
|
3.29 | PayeeInterBankCountryID | Char | 2 Letter ISO Code |
| valid country id |
3.30 | PayeeInterBankPostalCode | Alpha Numeric |
|
|
|
3.31 | PayeeInterBankRoutingCodeType | Alpha Numeric |
| Not null if Inter Bank is present | Swift/ABA |
3.32 | PayeeInterBankRoutingCode | Alpha Numeric |
| Not null if Inter Bank is present | Max 8 for swift, 9 for ABA |
3.33 | PayeeInterBankBankCode | Alpha Numeric |
|
|
|
3.34 | PayeeReference | Alpha Numeric |
|
|
|
3.35 | PayeeEmail | Alpha Numeric |
| Valid email id format Nullable |
|
3.36 | OriginatorID | Alpha Numeric |
|
| If valid org id is provided, no other info is required. The relevant info will be auto populated. |
3.37 | OriginatorName | Alpha Numeric |
|
|
|
3.38 | OriginatorAddress1 | Alpha Numeric |
|
| |
3.39 | OriginatorAddress2 | Alpha Numeric |
|
|
|
3.40 | OriginatorCity | Alpha Numeric |
|
|
|
3.41 | OriginatorProvince | Alpha Numeric |
|
|
|
3.42 | OriginatorCountryID | Char | 2 Letter ISO Code |
|
|
3.43 | OriginatorType | Enum | Consumer=0 and Buisness = 1 |
| |
3.44 | OriginatorAccountNumber | Alpha Numeric |
|
|
|
3.45 | PayeeInternalReference | Alpha Numeric | This can be internal id or reference of integrator database |
|
|
3.46 | PayeeSendingBankInstructions | Alpha Numeric |
| Max 200 character | Tax ID, Contact Name,Contact Phone |
ManagePayee API with POST Rest method allows you to Create Payees
\nAFXLink will validate new Payee data against Payee Intelligence in ManagePayee API with POST Method.
\nBased on Payee Intelligence configuration, fields can be required or not, require specific format or support specific values.
\nPayee Intelligence uses next 4 fields to determine requirements of other fields: PaymentMethod, PayeeCurrency, PayeeType and Country in PayeeBankAddress.
\nSee in Tables 1.B,C,D in Manage Payee - Create Payee which fields depend on Payee Intelligence.
\nTo get a csv file which contains up-to-date requirements to fields based on current Payee Intelligence configuration contact your account manager.
\nBoth Payee types use the same ManagePayee API structure, but Draft Payee uses only some fields (see Table 1.A of Create Payee process) in difference to Electronic Payee.
\nYou can specify is it Draft or Electronic Payee via PaymentMethod field:
\nDraft value = Draft Payee
\nWire or GlobalACH value = Electronic Payee
\nManagePayee API supports both Structured and Unstructured address formats during Create Payee process.
\nTo specify which exactly format you are provide use [Entity]AddressType field (e.g. PayeeAddressType) with next values:
\n0 - Unstructured
\n1 - Structured
\nNotes: This is not required field and when not provided AFXLink will use default value specified for your Organization.
\nNotes: You can specify different address formats for each [Entity]AddressType (e.g. Structured format for PayeeAddressType and Unstructured for PayeeBankAddressType)
\nInside [Entity]Address object you can provide one of 2 objects: UnstructuredAddress or StructuredAddress. See Tables 1.C,D of Create Payee with exact formats of UnstructuredAddress and StructuredAddress.
\nPayeeIdentityDocumentType supports different list of values based on Payee Intelligence configuration during Create Payee process.
\nTo get a csv file which contains list of all valid PayeeIdentityDocumentType values based on Payee Intelligence configuration contact your account manager.
\nPayeePurposeOfPayment supports different list of values based on Payee Intelligence configuration during Create Payee process.
\nTo get a csv file which contains list of all valid PayeePurposeOfPayment values based on Payee Intelligence configuration contact your account manager.
\nManagePayee API during Create Payee process validates that Payee with provided data doesn’t exist in the System already.
\nNext data is validated during Duplicate check of Electronic Payee:
\nPayeeName
\nPayeeNickName
\nPayeeCurrency
\nPaymentMethod
\nPayeeBankName
\nPayeeAccountNumber
\nBy Order Of (when configured for the client to be validated):
\nOriginatorName
\nOriginatorAccountNumber
\nNext data is validated during Duplicate check of Draft Payee:
\nPayeeName
\nPayeeAddress > Address1
\nPayeeAddress > City
\nPayeeAddress > Country
\nTable 1.A - ManagePayee API Request Structure for Create Electronic (Wite/GlobalACH) Payee
\nTable 1.B - ManagePayee API Request Structure for Create Draft Payee
\nTable 1.C - Unstructured Address format
\nTable 1.D - Structured Address format
\n","urlObject":{"path":["api","ManagePayee"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"7c756b7d-c8f4-4f03-b458-bca06c4080cc","name":"ManagePayee - Create Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"PayeeDetail\": {\r\n \"PayeeId\": 0,\r\n \"PayeeName\": \"Payee CZ PI 2 Test 3\",\r\n \"PayeeNickName\": \"MPCZTest\",\r\n \"PayeeDateOfBirth\": \"1990-10-14\",\r\n \"PayeeCurrency\": \"EUR\",\r\n \"PaymentMethod\": \"GlobalACH\",\r\n \"PayeeType\": 0,\r\n \"PayeeAddressType\": 1,\r\n \"PayeeAddress\": {\r\n \"UnstructuredAddress\": {\r\n \"Address1\": \"\",\r\n \"Address2\": \"\",\r\n \"City\": \"\",\r\n \"Province\": \"\",\r\n \"PostCode\": \"\",\r\n \"Country\": \"\"\r\n },\r\n \"StructuredAddress\": {\r\n \"Department\": \"dep 1\",\r\n \"SubDepartment\": \"sub dep 1\",\r\n \"StreetName\": \"str name 1\",\r\n \"BuildingNumber\": \"build number 1\",\r\n \"BuildingName\": \"build name 1\",\r\n \"Floor\": \"floor 1\",\r\n \"PostBox\": \"PB 1\",\r\n \"Room\": \"room 1\",\r\n \"PostCode\": \"post code 1\",\r\n \"TownName\": \"town name 1\",\r\n \"TownLocationName\": \"town loc name 1\",\r\n \"DistrictName\": \"distr name 1\",\r\n \"CountrySubDivision\": \"town loc name 1\",\r\n \"Country\": \"CZ\"\r\n }\r\n },\r\n \"PayeeInstructions\": \"Payee Instr\",\r\n \"PayeeEmailAddress\": \"anton.chepelenko@ascendant.world\",\r\n \"PayeePurposeOfPayment\": \"POP\",\r\n \"PayeeIdentityDocumentType\": \"Passport\",\r\n \"PayeeIdentityDocumentID\": \"CP-1234567\",\r\n \"PayeeTaxID\": \"CZ-12345\",\r\n \"PayeeBankTaxID\": \"12345\",\r\n \"PayeeContactPhone\": \"123456\",\r\n \"PayeeContactName\": \"test cn\",\r\n \"PayeeBankName\": \"AIR BANK A.S.\",\r\n \"PayeeBankAddressType\": 1,\r\n \"PayeeBankAddress\": {\r\n \"UnstructuredAddress\": {\r\n \"Address1\": \"\",\r\n \"Address2\": \"\",\r\n \"City\": \"\",\r\n \"Province\": \"\",\r\n \"PostCode\": \"\",\r\n \"Country\": \"\"\r\n },\r\n \"StructuredAddress\": {\r\n \"Department\": \"dep 2\",\r\n \"SubDepartment\": \"sub dep 2\",\r\n \"StreetName\": \"str name 2\",\r\n \"BuildingNumber\": \"build number 2\",\r\n \"BuildingName\": \"build name 2\",\r\n \"Floor\": \"floor 2\",\r\n \"PostBox\": \"PB 2\",\r\n \"Room\": \"room 2\",\r\n \"PostCode\": \"post code 2\",\r\n \"TownName\": \"town name 2\",\r\n \"TownLocationName\": \"town loc name 2\",\r\n \"DistrictName\": \"distr name 2\",\r\n \"CountrySubDivision\": \"town loc name 2\",\r\n \"Country\": \"CZ\"\r\n }\r\n },\r\n \"PayeeAccountNumber\": \"CZ6508000000192000145399\",\r\n \"PayeeBankSwiftCode\": \"AIRACZPPXXX\",\r\n \"PayeeBankLocalCode\": \"123456789012\",\r\n \"PayeeBankAccountType\": \"1\",\r\n \"PayeeInterBankName\": \"Interbank XYZ\",\r\n \"PayeeInterBankAddressType\": 0,\r\n \"PayeeInterBankAddress\": {\r\n \"UnstructuredAddress\": {\r\n \"Address1\": \"200 Interbank St\",\r\n \"Address2\": \"street 2\",\r\n \"City\": \"Chicago\",\r\n \"Province\": \"IL\",\r\n \"PostCode\": \"60601\",\r\n \"Country\": \"US\"\r\n },\r\n \"StructuredAddress\": {\r\n \"Department\": \"\",\r\n \"SubDepartment\": \"\",\r\n \"StreetName\": \"\",\r\n \"BuildingNumber\": \"\",\r\n \"BuildingName\": \"\",\r\n \"Floor\": \"\",\r\n \"PostBox\": \"\",\r\n \"Room\": \"\",\r\n \"PostCode\": \"\",\r\n \"TownName\": \"\",\r\n \"TownLocationName\": \"\",\r\n \"DistrictName\": \"\",\r\n \"CountrySubDivision\": \"\",\r\n \"Country\": \"\"\r\n }\r\n },\r\n \"PayeeInterBankRoutingType\": \"GlobalACH\",\r\n \"PayeeInterBankRoutingCode\": \"987654321\",\r\n \"OriginatorID\": \"0\",\r\n \"OriginatorName\": \"Acme Corp\",\r\n \"OriginatorAddressType\": 1,\r\n \"OriginatorAddress\": {\r\n \"UnstructuredAddress\": {\r\n \"Address1\": \"\",\r\n \"Address2\": \"\",\r\n \"City\": \"\",\r\n \"Province\": \"\",\r\n \"PostCode\": \"\",\r\n \"Country\": \"\"\r\n },\r\n \"StructuredAddress\": {\r\n \"Department\": \"dep 4\",\r\n \"SubDepartment\": \"sub dep 4\",\r\n \"StreetName\": \"str name 4\",\r\n \"BuildingNumber\": \"build number 4\",\r\n \"BuildingName\": \"build name 4\",\r\n \"Floor\": \"floor 4\",\r\n \"PostBox\": \"PB 4\",\r\n \"Room\": \"room 4\",\r\n \"PostCode\": \"post code 4\",\r\n \"TownName\": \"town name 4\",\r\n \"TownLocationName\": \"town loc name 4\",\r\n \"DistrictName\": \"distr name 4\",\r\n \"CountrySubDivision\": \"town loc name 4\",\r\n \"Country\": \"CZ\"\r\n }\r\n },\r\n \"OriginatorType\": 0,\r\n \"OriginatorAccountNumber\": \"987654321\"\r\n }","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/ManagePayee"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 04 Jun 2026 10:48:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"121"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ReqID","value":"26200103"},{"key":"OrgID","value":"0006820"},{"key":"LinkMethodName","value":"ManagePayeeCreate"},{"key":"ResID","value":"22697931"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"Code\": \"SUCCESS-00\",\n \"Message\": \"Success.\",\n \"Source\": \"\"\n }\n ],\n \"PayeeId\": \"893504\",\n \"PayeeName\": \"Payee CZ PI 2 Test 3\"\n}"}],"_postman_id":"91a6d195-e6a4-449a-a6f0-8595825df4d9"},{"name":"ManagePayee - Update Payee","id":"d16ba178-b472-47ef-9cd2-14e692cf4a5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":"ManagePayee API with PUT Rest method allows you to Update Payee in full mode.
\nNotes: Full mode - all Payee data will be updated with new data from API call. If some optional fields are not provided in API - value for them will be reset to Null for Payee
\nTo specify which Payee you want to update you can use PayeeID or PayeeNickname value.
\nPayeeID - ID of this Payee in Ascendant system, which you should have after Payee creation or you can get using ManagePayee API with GET Method.
\nPayeeNickname - should be your external identifier which you set during Create Payee. If by any reasons you don’t have your external ID of this Payee you can get value which we store using ManagePayee API with GET Method.
\nFor integrity of Payee Intelligence validation some fields are restricted for updated and ignored during Update of Payee. Ther values will stay as-is after Update Payee:
\nPaymentMethod
\nPayeeCurrency
\nPayeeType
\nCountry in PayeeBankAddress.
\nNotes: If you need to change any of this fields for Payee, you should create a new Payee and deactivate this one.
\nFor data integrity of Deal, if Payee is attached to a Pending Approval Deal or Deal is currently in synchronization process in Ascendant system, AFXLink will prohibit Payee update with appropriate Error Code/Error Message (see Table 1.A in Overview of ManagePayee API section)
\nIF Payee has Deals in Pending Approval (PAYEE-54 error code received) - you will need to approve all these Deals before updating Payee.
\nIF Payee has Deals in synchronization process in Ascendant system (PAYEE-55 error code received) - retry update Payee in a few minutes.
\nAFXLink will validate Updated Payee data against Payee Intelligence in ManagePayee API with POST Method.
\nBased on Payee Intelligence configuration, fields can be required or not, require specific format or support specific values.
\nPayee Intelligence uses next 4 fields to determine requirements of other fields: PaymentMethod, PayeeCurrency, PayeeType and Country in PayeeBankAddress.
\nSee in Tables 1.B,C,D in Manage Payee - Update Payee which fields depend on Payee Intelligence.
\nTo get a csv file which contains up-to-date requirements to fields based on current Payee Intelligence configuration contact your account manager.
\nBoth Payee types use the same ManagePayee API structure, but Draft Payee uses only some fields (see Table 1.A of Update Payee process) in difference to Electronic Payee.
\nYou can specify is it Draft or Electronic Payee via PaymentMethod field:
\nDraft value = Draft Payee
\nWire or GlobalACH value = Electronic Payee
\nManagePayee API supports both Structured and Unstructured address formats during Update Payee process.
\nTo specify which exactly format you are provide use [Entity]AddressType field (e.g. PayeeAddressType) with next values:
\n0 - Unstructured
\n1 - Structured
\nNotes: This is not required field and when not provided AFXLink will use default value specified for your Organization.
\nNotes: You can specify different address formats for each [Entity]AddressType (e.g. Structured format for PayeeAddressType and Unstructured for PayeeBankAddressType)
\nInside [Entity]Address object you can provide one of 2 objects: UnstructuredAddress or StructuredAddress. See Tables 1.C,D of Update Payee with exact formats of UnstructuredAddress and StructuredAddress.
\nPayeeIdentityDocumentType supports different list of values based on Payee Intelligence configuration during Update Payee process.
\nTo get a csv file which contains list of all valid PayeeIdentityDocumentType values based on Payee Intelligence configuration contact your account manager.
\nPayeePurposeOfPayment supports different list of values based on Payee Intelligence configuration during Update Payee process.
\nTo get a csv file which contains list of all valid PayeePurposeOfPayment values based on Payee Intelligence configuration contact your account manager.
\nManagePayee API during Update Payee process validates that Updated Payee data will not cause duplication with other existing Payees in the System.
\nNext data is validated during Duplicate check of Electronic Payee:
\nPayeeName
\nPayeeNickName
\nPayeeCurrency
\nPaymentMethod
\nPayeeBankName
\nPayeeAccountNumber
\nBy Order Of (when configured for the client to be validated):
\nOriginatorName
\nOriginatorAccountNumber
\nNext data is validated during Duplicate check of Draft Payee:
\nPayeeName
\nPayeeAddress > Address1
\nPayeeAddress > City
\nPayeeAddress > Country
\nTable 1.A - ManagePayee API Request Structure for Update Electronic (Wite/GlobalACH) Payee
\nTable 1.B - ManagePayee API Request Structure for Update Draft Payee
\nTable 1.C - Unstructured Address format
\nTable 1.D - Structured Address format
\n","urlObject":{"path":["api","ManagePayee"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"847c019c-892e-499b-94cc-818d89da7988","name":"ManagePayee - Update Payee","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"PayeeDetail\": {\r\n \"PayeeId\": 893502,\r\n \"PayeeName\": \"Payee CZ PI 2 Test 2\",\r\n \"PayeeNickName\": \"MPCZTest 2\",\r\n \"PayeeDateOfBirth\": \"1990-10-14\",\r\n \"PayeeCurrency\": \"EUR\",\r\n \"PaymentMethod\": \"Wire\",\r\n \"PayeeType\": 0,\r\n \"PayeeAddressType\": 1,\r\n \"PayeeAddress\": {\r\n \"UnstructuredAddress\": {\r\n \"Address1\": \"\",\r\n \"Address2\": \"\",\r\n \"City\": \"\",\r\n \"Province\": \"\",\r\n \"PostCode\": \"\",\r\n \"Country\": \"\"\r\n },\r\n \"StructuredAddress\": {\r\n \"Department\": \"dep 1\",\r\n \"SubDepartment\": \"sub dep 1\",\r\n \"StreetName\": \"str name 1\",\r\n \"BuildingNumber\": \"build number 1\",\r\n \"BuildingName\": \"build name 1\",\r\n \"Floor\": \"floor 1\",\r\n \"PostBox\": \"PB 1\",\r\n \"Room\": \"room 1\",\r\n \"PostCode\": \"post code 1\",\r\n \"TownName\": \"town name 1\",\r\n \"TownLocationName\": \"town loc name 1\",\r\n \"DistrictName\": \"distr name 1\",\r\n \"CountrySubDivision\": \"town loc name 1\",\r\n \"Country\": \"CZ\"\r\n }\r\n },\r\n \"PayeeInstructions\": \"Payee Instr\",\r\n \"PayeeEmailAddress\": \"anton.chepelenko@ascendant.world\",\r\n \"PayeePurposeOfPayment\": \"POP\",\r\n \"PayeeIdentityDocumentType\": \"Passport\",\r\n \"PayeeIdentityDocumentID\": \"CP-1234567\",\r\n \"PayeeTaxID\": \"CZ-12345\",\r\n \"PayeeBankTaxID\": \"12345\",\r\n \"PayeeContactPhone\": \"123456\",\r\n \"PayeeContactName\": \"test cn\",\r\n \"PayeeBankName\": \"AIR BANK A.S.\",\r\n \"PayeeBankAddressType\": 1,\r\n \"PayeeBankAddress\": {\r\n \"UnstructuredAddress\": {\r\n \"Address1\": \"\",\r\n \"Address2\": \"\",\r\n \"City\": \"\",\r\n \"Province\": \"\",\r\n \"PostCode\": \"\",\r\n \"Country\": \"\"\r\n },\r\n \"StructuredAddress\": {\r\n \"Department\": \"dep 2\",\r\n \"SubDepartment\": \"sub dep 2\",\r\n \"StreetName\": \"str name 2\",\r\n \"BuildingNumber\": \"build number 2\",\r\n \"BuildingName\": \"build name 2\",\r\n \"Floor\": \"floor 2\",\r\n \"PostBox\": \"PB 2\",\r\n \"Room\": \"room 2\",\r\n \"PostCode\": \"post code 2\",\r\n \"TownName\": \"town name 2\",\r\n \"TownLocationName\": \"town loc name 2\",\r\n \"DistrictName\": \"distr name 2\",\r\n \"CountrySubDivision\": \"town loc name 2\",\r\n \"Country\": \"CZ\"\r\n }\r\n },\r\n \"PayeeAccountNumber\": \"CZ6508000000192000145399\",\r\n \"PayeeBankSwiftCode\": \"AIRACZPPXXX\",\r\n \"PayeeBankLocalCode\": \"123456789012\",\r\n \"PayeeBankAccountType\": \"1\",\r\n \"PayeeInterBankName\": \"Interbank XYZ\",\r\n \"PayeeInterBankAddressType\": 0,\r\n \"PayeeInterBankAddress\": {\r\n \"UnstructuredAddress\": {\r\n \"Address1\": \"200 Interbank St\",\r\n \"Address2\": \"street 2\",\r\n \"City\": \"Chicago\",\r\n \"Province\": \"IL\",\r\n \"PostCode\": \"60601\",\r\n \"Country\": \"US\"\r\n },\r\n \"StructuredAddress\": {\r\n \"Department\": \"\",\r\n \"SubDepartment\": \"\",\r\n \"StreetName\": \"\",\r\n \"BuildingNumber\": \"\",\r\n \"BuildingName\": \"\",\r\n \"Floor\": \"\",\r\n \"PostBox\": \"\",\r\n \"Room\": \"\",\r\n \"PostCode\": \"\",\r\n \"TownName\": \"\",\r\n \"TownLocationName\": \"\",\r\n \"DistrictName\": \"\",\r\n \"CountrySubDivision\": \"\",\r\n \"Country\": \"\"\r\n }\r\n },\r\n \"PayeeInterBankRoutingType\": \"GlobalACH\",\r\n \"PayeeInterBankRoutingCode\": \"987654321\",\r\n \"OriginatorID\": \"0\",\r\n \"OriginatorName\": \"Acme Corp\",\r\n \"OriginatorAddressType\": 1,\r\n \"OriginatorAddress\": {\r\n \"UnstructuredAddress\": {\r\n \"Address1\": \"\",\r\n \"Address2\": \"\",\r\n \"City\": \"\",\r\n \"Province\": \"\",\r\n \"PostCode\": \"\",\r\n \"Country\": \"\"\r\n },\r\n \"StructuredAddress\": {\r\n \"Department\": \"dep 4\",\r\n \"SubDepartment\": \"sub dep 4\",\r\n \"StreetName\": \"str name 4\",\r\n \"BuildingNumber\": \"build number 4\",\r\n \"BuildingName\": \"build name 4\",\r\n \"Floor\": \"floor 4\",\r\n \"PostBox\": \"PB 4\",\r\n \"Room\": \"room 4\",\r\n \"PostCode\": \"post code 4\",\r\n \"TownName\": \"town name 4\",\r\n \"TownLocationName\": \"town loc name 4\",\r\n \"DistrictName\": \"distr name 4\",\r\n \"CountrySubDivision\": \"town loc name 4\",\r\n \"Country\": \"CZ\"\r\n }\r\n },\r\n \"OriginatorType\": 0,\r\n \"OriginatorAccountNumber\": \"987654321\"\r\n }","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/ManagePayee"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 04 Jun 2026 10:27:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"121"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ReqID","value":"26200030"},{"key":"OrgID","value":"0006820"},{"key":"LinkMethodName","value":"ManagePayeeUpdate"},{"key":"ResID","value":"22697858"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"Code\": \"SUCCESS-00\",\n \"Message\": \"Success.\",\n \"Source\": \"\"\n }\n ],\n \"PayeeId\": \"893502\",\n \"PayeeName\": \"Payee CZ PI 2 Test 2\"\n}"}],"_postman_id":"d16ba178-b472-47ef-9cd2-14e692cf4a5a"},{"name":"ManagePayee - Deactivate Payee","id":"bd366f55-4a4b-4947-b913-96ad1175cba6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":"ManagePayee API with PATCH Rest method allows you to Deactivate Payee.
\nTo Deactivate Payee you will need to provide PayeeID or PayeeNickname of existing Payee and PayeeStatus = 0 in Request body.
\nNotes: Pay attention that reactivation of Payee is prohibited. You can only deactivate active Payee using PATCH Rest method.
\nTo specify which Payee you want to deactivate you can use PayeeID or PayeeNickname value.
\nPayeeID - ID of this Payee in Ascendant system, which you should have after Payee creation or you can get using ManagePayee API with GET Method.
\nPayeeNickname - should be your external identifier which you set during Create Payee. If by any reasons you don’t have your external ID of this Payee you can get value which we store using ManagePayee API with GET Method.
\nTable 1.A - ManagePayee API Request Structure for Deactivate Payee
\n","urlObject":{"path":["api","ManagePayee"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"1099eef8-b12d-4630-b6d5-3c7565b2f90d","name":"ManagePayee - Deactivate Payee","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"PayeeDetail\": {\r\n \"PayeeId\": 893502,\r\n \"PayeeNickName\": \"MPCZTest 2\",\r\n \"PayeeStatus\": 0\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/ManagePayee"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 04 Jun 2026 10:39:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"86"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ReqID","value":"26200063"},{"key":"OrgID","value":"0006820"},{"key":"LinkMethodName","value":"ManagePayeeDeActive"},{"key":"ResID","value":"22697891"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"Code\": \"SUCCESS-00\",\n \"Message\": \"Success.\",\n \"Source\": \"\"\n }\n ],\n \"PayeeId\": \"893502\"\n}"}],"_postman_id":"bd366f55-4a4b-4947-b913-96ad1175cba6"},{"name":"ManagePayee - Get Payee","id":"be95f0d5-e3bd-4041-a8d2-c465fcc4bf02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":"ManagePayee API with GET Rest method allows you to Get Payee(s) data.
\nAPI call will return list of Payees which match provided filters (see Search/filter Payees in Get Payee below).
\nYou can use next URL params to search/filter Payees you will receive in response:
\nOrgID - required
\nPayeeID - required IF PayeeNickname not provided
\nPayeeNickname - required IF PayeeID not provided
\nPaymentMethod - not-required
\nNotes: To search across Draft Payees you need to provide PaymentMethod = Draft. When PaymentMethod not provided AFXLink will search across Electronic Payees by default (Wire and GlobalACH)
\nNext operators are supported for URL params:
\nAFXLink will use params provided in URL from the list above to search/filter Payees using AND logic.
\nParams should be provided in format:
\n{{Base URL}}/ManagePayee?[Param 1]=[value]&…&[Param N]=[value].
\ne.g. {{Base URL}}/ManagePayee?OrgID=[your OrgID]&PaymentMethod=wire
\nUntil we will implement Structured Address support across whole system we will return Address in response in Unstructured Format. If you have provided Address in Structured format for Payee it will be converted to Unstructured.
\nResponse structure already contains Structured Address but it will be always empty until full support will be implemented.
\nN/A, URL params should be used to search/filter Payees.
\nOnly OrgID param with value is required.
\nTable 1.A - ManagePayee API Response Structure for Get Payee
\n","urlObject":{"path":["api","","ManagePayee"],"host":["{{BaseURL}}"],"query":[{"key":"OrgID","value":"{{OrgID}}"},{"key":"PayeeID","value":"893504"},{"key":"PaymentMethod","value":"globalach"}],"variable":[]}},"response":[{"id":"f4563eda-a767-4ce1-bb37-7fcd56f7bce9","name":"ManagePayee - Get Payee","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BaseURL}}/api//ManagePayee?OrgID={{OrgID}}&PayeeID=893504&PaymentMethod=globalach","host":["{{BaseURL}}"],"path":["api","","ManagePayee"],"query":[{"key":"OrgID","value":"{{OrgID}}"},{"key":"PayeeID","value":"893504"},{"key":"PaymentMethod","value":"globalach"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 04 Jun 2026 10:49:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1965"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ReqID","value":"26200104"},{"key":"OrgID","value":"0006820"},{"key":"LinkMethodName","value":"ManagePayeeInfo"},{"key":"ResID","value":"22697932"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"Code\": \"SUCCESS-00\",\n \"Message\": \"SUCCESS.\",\n \"Source\": \"SYSTEM\"\n }\n ],\n \"NumberOfPayees\": 1,\n \"PayeeDetail\": [\n {\n \"OriginatorAccountNumber\": \"987654321\",\n \"OriginatorAddress\": {\n \"StructuredAddress\": null,\n \"UnstructuredAddress\": {\n \"Address1\": \"str name 4,build number 4,build name 4,PB 4\",\n \"Address2\": \"floor 4,room 4,dep 4,sub dep 4\",\n \"City\": \"town name 4\",\n \"Country\": \"Czechia\",\n \"PostCode\": \"post code 4\",\n \"Province\": \"\"\n }\n },\n \"OriginatorAddressType\": 0,\n \"OriginatorID\": null,\n \"OriginatorName\": \"Acme Corp\",\n \"OriginatorType\": 1,\n \"PayeeAccountNumber\": \"CZ6508000000192000145399\",\n \"PayeeAddress\": {\n \"StructuredAddress\": null,\n \"UnstructuredAddress\": {\n \"Address1\": \"str name 1,build number 1,build name 1,PB 1\",\n \"Address2\": \"floor 1,room 1,dep 1,sub dep 1\",\n \"City\": \"town name 1\",\n \"Country\": \"Czechia\",\n \"PostCode\": \"post code 1\",\n \"Province\": \"\"\n }\n },\n \"PayeeAddressType\": 0,\n \"PayeeBankAccountType\": 1,\n \"PayeeBankAddress\": {\n \"StructuredAddress\": null,\n \"UnstructuredAddress\": {\n \"Address1\": \"EVROPSKA 2690\",\n \"Address2\": \"17\",\n \"City\": \"PRAGUE\",\n \"Country\": \"Czechia\",\n \"PostCode\": \"post code 2\",\n \"Province\": \"PRAGUE\"\n }\n },\n \"PayeeBankAddressType\": 0,\n \"PayeeBankLocalCode\": \"\",\n \"PayeeBankName\": \"AIR BANK A.S.\",\n \"PayeeBankSwiftCode\": \"AIRACZPPXXX\",\n \"PayeeBankTaxID\": \"\",\n \"PayeeContactName\": \"test cn\",\n \"PayeeContactPhone\": \"123456\",\n \"PayeeCurrency\": \"EUR\",\n \"PayeeDateOfBirth\": \"1990-10-14\",\n \"PayeeEmailAddress\": \"anton.chepelenko@ascendant.world\",\n \"PayeeId\": 893504,\n \"PayeeIdentityDocumentID\": \"CP-1234567\",\n \"PayeeIdentityDocumentType\": \"54\",\n \"PayeeInstructions\": \"Payee Instr\",\n \"PayeeInterBankAddress\": {\n \"StructuredAddress\": null,\n \"UnstructuredAddress\": {\n \"Address1\": \"200 Interbank St\",\n \"Address2\": \"street 2\",\n \"City\": \"Chicago\",\n \"Country\": \"United States\",\n \"PostCode\": \"60601\",\n \"Province\": \"IL\"\n }\n },\n \"PayeeInterBankAddressType\": 0,\n \"PayeeInterBankName\": \"Interbank XYZ\",\n \"PayeeInterBankRoutingCode\": \"987654321\",\n \"PayeeInterBankRoutingType\": \"GlobalACH\",\n \"PayeeName\": \"Payee CZ PI 2 Test 3\",\n \"PayeeNickName\": \"MPCZTest\",\n \"PayeePurposeOfPayment\": \"POP\",\n \"PayeeTaxID\": \"CZ-12345\",\n \"PayeeType\": 0,\n \"PaymentMethod\": \"GlobalACH\"\n }\n ]\n}"}],"_postman_id":"be95f0d5-e3bd-4041-a8d2-c465fcc4bf02"}],"id":"241dfd70-b386-474a-905b-fbc99c28e294","description":"ManagePayee API allows you to manage your Payees in a few ways:
\nCreate new Payees
\nUpdate existing Payees
\nActivate/Deactivate Payees
\nGet existing Payee Data
\nManagePayee API is RESTful API, which uses REST Methods to specify what exactly you want to do with Payee
\nBased on REST Method some fields are required/non-required or used/ignored in ManagePayee API. Still you can use same API structure for all REST Methods and just provide values in fields which are needed.
\nSee separate pages ManagePayee - Create Payee / Update Payee / Deactivate Payee / Get Payee Data for exact API structure.
\nManagePayee API supports Payee Intelligence in Create/Update Payee process.
\nBased on Payee Intelligence configuration, fields can be required or not, require specific format or support specific values.
\nPayee Intelligence uses next 4 fields to determine requirements of other fields: PaymentMethod, PayeeCurrency, PayeeType and Country in PayeeBankAddress.
\nSee in Tables 1.B,C,D in Manage Payee - Create/Update Payee which fields depend on Payee Intelligence.
\nTo get a csv file which contains up-to-date requirements to fields based on current Payee Intelligence configuration contact your account manager.
\nBoth Payee types use the same API in Create/Update Payee process and same request structure, but Draft Payee uses only some fields (see Table 1.A of Create/Update Payee process) in difference to Electronic Payee.
\nYou can specify is it Draft or Electronic Payee via PaymentMethod field:
\nDraft value = Draft Payee
\nWire or Global ACH value = Electronic Payee
\nManagePayee API supports both Structured and Unstructured address formats during Create/Update Payee process.
\nTo specify which exactly format you are provide use [Entity]AddressType field (e.g. PayeeAddressType) with next values:
\n0 - Unstructured
\n1 - Structured
\nNotes: This is not required field and when not provided AFXLink will use default value specified for your Organization.
\nNotes: You can specify different address formats for each [Entity]AddressType (e.g. Structured format for PayeeAddressType and Unstructured for PayeeBankAddressType)
\nInside [Entity]Address object you can provide one of 2 objects: UnstructuredAddress or StructuredAddress. See Tables 1.C,D of Create/Update Payee with exact formats of UnstructuredAddress and StructuredAddress.
\nPayeeIdentityDocumentType supports different list of values based on Payee Intelligence configuration during Create/Update Payee process.
\nTo get a csv file which contains list of all valid PayeeIdentityDocumentType values based on Payee Intelligence configuration contact your account manager.
\nPayeePurposeOfPayment supports different list of values based on Payee Intelligence configuration during Create/Update Payee process.
\nTo get a csv file which contains list of all valid PayeePurposeOfPayment values based on Payee Intelligence configuration contact your account manager.
\nManagePayee API during Create/Update Payee process validates that Payee with provided data doesn’t exist in the System already.
\nNext data is validated during Duplicate check of Electronic Payee:
\nPayeeName
\nPayeeNickName
\nPayeeCurrency
\nPaymentMethod
\nPayeeBankName
\nPayeeAccountNumber
\nBy Order Of (when configured for the client to be validated):
\nOriginatorName
\nOriginatorAccountNumber
\nNext data is validated during Duplicate check of Draft Payee:
\nPayeeName
\nPayeeAddress > Address1
\nPayeeAddress > City
\nPayeeAddress > Country
\nManagePayee API is using new Error Codes/Messages format of AFXLink API v2.
\nManagePayee API will return as many errors in response as the Ascendant system was able to detect at the same time.
\nWhen any errors occur AFXLink will return list of all errors which have occurred in response in the next format:
\n{\n \"Errors\": [\n {\n \"Code\": \"<Error Code for error 1>\",\n \"Source\": \"<Field 1 which triggered error>\",\n \"Message\": \"<error message value for error 1>\",\n },\n ...\n {\n \"Code\": \"<Error Code for error N>\"\",\n \"Source\": \"<Field N which triggered error>\",\n \"Message\": \"<error message value for error N>\",\n }\n ],\n \"PayeeID\": \"\",\n ...\n}\n\nTable 1.A - AFXLink error codes and error messages templates for ManagePayee API
\nTable 1.B - List of Field IDs in Error Message corresponded Fields in API
\n","_postman_id":"241dfd70-b386-474a-905b-fbc99c28e294"},{"name":"Submit Deal","item":[{"name":"SubmitDealAutoQuote_0_0_5","event":[{"listen":"prerequest","script":{"id":"6ce53528-0a14-4390-9d37-3e3211759b6b","exec":["pm.collectionVariables.get(\"BaseURL\");\r","pm.collectionVariables.get(\"APIUsername\");\r","pm.collectionVariables.get(\"APIPassword\");\r","pm.collectionVariables.get(\"OrgID\");"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ffc660b6-7d56-4be3-87fb-2c41a1a7e830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":"The SubmitDealAutoQuote API with Payee Inteligence 2 support allows you to submit a new FX deal with next options:
\nAuto or Manual Quote
\nUsing specific Settlement Account or default one
\nSpecify is new Deal require approval or not
\nUse Global ACH and Wire Payees
\nTo use Auto Quote feature you can provide QuoteID = 0 or simply not provide QuoteID at all. In this case AFXLink will automatically intiate Quote creation on the moment of Deal creation and accept it.
\nAlternatively, you can also use SubmitDealAutoQuote with a manually created quote obtained via the GetQuote API. In this case, you must provide valid Quote ID in QuoteID field and ensure that the data in the SubmitDealAutoQuote request match the original manual quote:
\nDirection in Payment matches Direction in Manual Quote
\nPaymentMethod of Payee matches PaymentMethod of Manual Quote
\nCurrency of Payee matches FXCurrencyID of Manual Quote
\nFXAmount in Payment matches FXAmount in Manual Quote
\nSettlementCurrencyID in Payment matches SettlementCurrencyID in Manual Quote
\nSettlementAmount in Payment matches SettlementAmount in Manual Quote
\nThis ensures consistency and successful deal processing.
\nYou can specify Settlement Account, which you want to use as funding source for this deal, using SettlementMethod and SettlementAccountID. Both values should be provided as combination of method and Account ID
\nSettlementMethod supports 4 values to specify which Settlement Account by method:
\nachdebit
\nwire
\npad
\nholdingac
\nNotes: values are case insensitive.
\nSettlementAccountID value is expected to contain:
\nID of Holding Account when SettlementMethod = holdingac
\nID of Payor when SettlementMethod = achdebit, wire or pad
\nWhen Settlement Account (SettlementMethod and SettlementAccountID) are not provided AFXLink will use default Settlement Account configured for your OrgID.
\nYou have an option to specify Deal direction via Direction property:
\n0 - Buy (Funds transferred TO specified Payee/Payor)
\n1 - Sell (Funds charged FROM specified Payee/Payor)
\nYou can specify if new Deal with Payments require approval or not. To do that you should use IsApprovalRequired property. It supports 2 values:
\n0 - Deal doesn’t required approval
\n1 - Deal requires approval
\nWhen IsApprovalRequired property is not provided in API call, the System treats it as Deal doesn’t required approval.
\nAFXLink can validate Payment for duplicates using your External ID, which you should provide in YourPaymentId.
\nUsing YourPaymentId AFXLink will validate if Payments created for the last month (from Current Date - 1 month to Current Date) with the same YourPaymentId already exist in the System.
\nTo specify existing Payee/Payor you need provide Payee/Payor ID via PayeeID property within PayeeDetail object in API
\n