{"info":{"_postman_id":"787aae2b-3eaf-451a-a23a-b3b4a4ed0360","name":"AFXLink API Reference Guide for Trolley","description":"

1. PAYMENT SOLUTIONS OVERVIEW

\n

Ascendant provides payment solutions that allow to send payment anytime with flexible tools. The AFXLink Developer Platform provides APIs for you to integrate Ascendant payments into your applications to process online, in-app, and in-person payments.

\n

This document is intended for use by developers to integrate their system/application with the AFXLink API platform.

\n

2. GETTING STARTED

\n

This section provides an overview of steps involved in successfully undertaking the integration.

\n

Get started with AFXLink APIs and test them on Postman. Generate API Keys in Test and Live Modes.

\n

AFXLink APIs are completely RESTful, and all our responses are returned in JSON.

\n

2.1 Postman Guide

\n

Use Postman to explore AFXLink REST APIs with a developer account. You can customize requests and receive responses for any of AFxLink API methods.

\n

You can test APIs right away by forking AFxLink's Postman collection.

\n
    \n

  1. Sign up or log in to an account on postman.com.

    \n
    2. \n

  2. Select the following Run in Postman button:

    \n
    3. \n
\n

\n

2.2 API KEY

\n

You can use AFXLink APIs in two modes, Test and Live. The API keys are different for each mode. Get your API Key to the Sandbox for Test Mode. Contact your account manager to get this generated.

\n

API Authentication
All AFXLink APIs are authenticated using Basic Auth. Basic auth requires the following:

\n

[YOUR_KEY_ID]
[YOUR_KEY_SECRET]

\n

Basic auth expects an Authorization header for each request in the Basic base64token format. Here, base64token is a base64 encoded string of YOUR_KEY_ID:YOUR_KEY_SECRET.

\n

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.

\n

While integrating AFXLink APIs with your application, ensure that:

\n\n

2.3 RELEASE/DEPLOYMENT MODEL

\n

a. Regular

\n\n\n

b. Fast Track

\n\n\n

2.4 API GATEWAY URL

\n

The URL to the API service is either:

\n

Sandbox. https://afxlink-staging.ascendantfx.com/
Live. https://trolley-api.ascendant.world

\n

You need to include this before each API endpoint to make API calls.

\n

Getting handshake endpoint

\n

You can use below endpoint to runs a health check or ping on the AFXLink API.
If the web service accessable, will return its latest version with response status OK

\n

https://afxlink-staging.ascendantfx.com/api/getservice/status

\n

3. CORE RESOURCES

\n

3.1 API Entities

\n

These are the various terminology being used in api integration and api payloads.

\n

i. Client
Client is the sender of payment instruction and will call the api method to book the Deals from their application and servers.

\n

Client needs to be register on ascendant platform and will be issued organization id and api credentials to access the api.

\n

ii. Payee
Payee objects represent the recipient information and consist of various information related to it like.
Payee Information: Name, Mail id, Currency, Address, Account number etc
Payee Bank Information: Details of bank where recipient have the account and will receive the payment.
Originator Info: In case or FI customers, details of Originator information who send the payment through clients.

\n

iii.Payment

\n

Payment object represents transaction information like payment amount, payment currency, payment method, Settlement amount, Settlement currency, Settlement method, fee and related payee object.

\n

iv. Deal

\n

A Deal id collection of one or more payment objects. With the help of deal object, multiple payment instruction can be sent in bulk at once with one settlement / funding source.

\n

v. Quote

\n

Quote object represent 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.

\n

3.2 API Object Flow

\n

Following will be flow of object creations using api methods/endpoint in order to book deals on ascendant platform.

\n

i. Payee Creation
You can use add payee, update payee api methods to insert payee object.

\n

On successful payee creation you will get PayeeID, which you can keep in your database to reuse with submit deals.

\n

Alternatively, you can provide payee object with submit deal api method. In this case the payee object will be created first internally before submitting deal. If payee object already exists, then the payee will be updated first before submitting deal.

\n

ii.Quote Creation
You can use GeQuote and GetQuoteTBA methods to get rates of a allowed currency pair and calculate payment and settlement amounts.

\n

iii. Accept Quote
Before submitting the deal you need to accept the quote with help of AcceptQuote method. The rate will have expiration period of two hours. After this you have to generate new quote to submit a deal

\n

iv. Submit Deal
After accepting the quote you can submit the deal with valid QuoteID, accepted payment information and valid payeeID or payee object information.
After successful deal creation you will get AFXDealID, which you can use further to track- status and reconciliation process.

\n

v. PostDeal
You can get list of all successful deals and payments and use to reconcile with your system.
You can use PaymentID returned in response to trace the remittance on swift network using GetPaymentStatus method.

\n

vi. PostDealConfirmation
You can use this to mark the payment as reconciled in your system, so you will get un reconciled and latest deal/payment information through PostDeal method in subsequent calls .
This will keep the post deal response short and will get only new deals and will reduce the network latency on api calls.

\n

3.3 Use Cases For Selecting Methods

\n

i. Just need to submit deal in one go.
Use SubmitDealAutoQuote method with payee object. This will create payee object and getquote and accept internally on the basis of current market rate and submit the deal.

\n

ii. Need Control on getQuote and accept before submitting deal
Use GetQuote, AcceptQuote and SubmitDeal in same sequence.

\n

iii. Want to create payee database on ascendant and want to reuse for subsequent calls in future.

\n

Use AddPayee followed by SubmitDealAutoQuote with PayeeID reference or (GetQuote + AcceptQuote+ SubmitDeal ) with PayeeID reference

\n

iv. Want manual approval system on web plateform, afetr submiting deals through API

\n

Use SubbmitDealForApproval along with GetQuote and AcceptQuote.

\n

After 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 cab be release for payment.

\n

3.4 API METHODS
Check out the list of methods in the list. Explore possible use cases/objectives you can meet
with using them.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MethodsBrief Description
GetQuoteGet quote
AcceptQuoteTo accept quote
SubmitDeal v 0_0_1To submit deal – specify funding acc number
ValidateIBANValidates the IBAN
GetAccountBalancev0_0_1Get AFX holding account balance – with AC Unique ID
GetFundingAccountListGenerate List of All Funding Accounts Configured for a given account. It returns details of both external and internal accounts
AddPayeeTo add a new payee
UpdatePayeeTo update a given payee’s information
DeletePayeeTo delete a given payee
GetAccountActivityv0_0_2Returns ledger by days, debit/credit, specific deal #
GetQuoteTBAGet a quote when transferring funds from one holding account for a given currency to another account for a different currency
GetPaymentStatusGet Payments Status by Payment_Id
AcceptAndSubmitDealTBASubmit the request to transfer funds from holding account to the other based on the rate provided in GetQuoteTBA
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31228683","collectionId":"787aae2b-3eaf-451a-a23a-b3b4a4ed0360","publishedId":"2sAYX5K2P5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-03T15:03:00.000Z"},"item":[{"name":"Quote","item":[{"name":"GetQuote","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","id":"f89858f5-d21c-43f5-ba2a-430253988c20"}}],"id":"05372559-c3d7-4999-82f2-15cb08bbf654","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"MethodID\": \"AFXEWSGQ\",\r\n \"OrgID\": \"{{OrgID}}\",\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":"{{BaseURL}}/api/GetQuote","description":"

Request

\n

Sr.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

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

 

For Direction = Buy: Allowed Methods are: Wire,ACH, EFT, Draft

For Direction = Sell: Allowed Methods are: Wire, Cheque, ACHDebit, PAD

Not null

 

4.4

FX Currency ID

Char

 

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 and 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

\n\n

Response

\n

Sr.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

\n\n

Quote Validity

\n

Quote is valid (rate hold) for 2 hours (120 minutes). The rate provided expires after and cannot be used. A fresh new quote must be requested.

\n","urlObject":{"path":["api","GetQuote"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"c2b43021-2c6e-41ae-941a-8836d34f8bfe","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"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 09 Nov 2023 10:03:25 GMT"},{"key":"Content-Length","value":"400"}],"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":"05372559-c3d7-4999-82f2-15cb08bbf654"},{"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":"073fa28d-1fbe-4360-9371-86bc248d669f"}}],"id":"42cb9f26-4bf8-4f2e-9e42-d21169c3905e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"MethodID\": \"AFXEWSAQ\",\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"QuoteID\":2750310\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/AcceptQuote","description":"

Request

\n

Sr.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

\n\n

Response

\n

Sr.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

","urlObject":{"path":["api","AcceptQuote"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"a3e07591-1ac7-45f0-beac-b5077988acbf","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"MethodID\": \"AFXEWSAQ\",\r\n \"OrgID\": \"1871761\",\r\n \"QuoteID\":2750353\r\n}","options":{"raw":{"language":"json"}}},"url":"https://afxlink-staging.ascendantfx.com/api/AcceptQuote"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 09 Nov 2023 10:07:22 GMT"},{"key":"Content-Length","value":"58"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"QuoteID\": 2727563\n}"}],"_postman_id":"42cb9f26-4bf8-4f2e-9e42-d21169c3905e"},{"name":"GetQuoteTBA","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":"54e399d9-344d-4625-8fa9-8934b5872ce2"}}],"id":"b8740f89-9f4c-4103-85d1-b8aba6bdbe09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXWSVIFSQ\",\r\n \"FromAccountNumber\": \"0001855\",\r\n \"FxAmount\": 100.0,\r\n \"ToAccountNumber\": \"0001855\",\r\n \"SettlementAmount\": 1.0\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/GetQuoteTBA","description":"

Request

\n

Sr.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
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
\n\n

Response

\n

Sr.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

","urlObject":{"path":["api","GetQuoteTBA"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"e247c1f3-9702-4d9d-9407-439a51ad3cd2","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": 1871761,\r\n \"MethodID\": \"AFXWSVIFSQ\",\r\n \"FromAccountNumber\": \"0001853\",\r\n \"FxAmount\": 100.0,\r\n \"ToAccountNumber\": \"0001855\",\r\n \"SettlementAmount\": 1.0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://afxlink-staging.ascendantfx.com/api/GetQuoteTBA"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 04 Jun 2024 12:39:16 GMT"},{"key":"Content-Length","value":"381"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"Fee\": 0,\n \"FromAccountNumber\": \"0001853\",\n \"FxAmount\": 100,\n \"FxCurrencyID\": \"CAD\",\n \"PaymentMethod\": null,\n \"Quote\": {\n \"ExpiryTime\": \"/Date(1717511957061-0400)/\",\n \"ID\": 2750318,\n \"QuoteDateTime\": \"/Date(1717504757061-0400)/\"\n },\n \"Rate\": 1.37466915,\n \"SettlementAmount\": 72.74,\n \"SettlementCurrencyID\": \"USD\",\n \"ToAccountNumber\": \"0001855\",\n \"TotalSettlementAmount\": 72.74\n}"}],"_postman_id":"b8740f89-9f4c-4103-85d1-b8aba6bdbe09"}],"id":"9093d7f4-03b9-4e1b-b3f3-cd635bb2b398","description":"

These 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":"9093d7f4-03b9-4e1b-b3f3-cd635bb2b398"},{"name":"Submit Deal","item":[{"name":"AcceptAndSubmitDealTBA","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":"55f60749-3cf1-4739-bb8d-39118b25f931"}}],"id":"05283559-fc4e-4ef5-9b49-87a667b5e85c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSAQ\",\r\n \"QuoteID\": 2726883\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/AcceptAndSubmitDealTBA","description":"

Request

\n

Sr.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

\n\n

Response

\n

Sr.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
","urlObject":{"path":["api","AcceptAndSubmitDealTBA"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"b8be4890-bd5e-4e2b-b09a-9470a5aee3ea","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": 1871761,\r\n \"MethodID\": \"AFXEWSAQ\",\r\n \"QuoteID\":2750318\r\n}","options":{"raw":{"language":"json"}}},"url":"https://afxlink-staging.ascendantfx.com/api/AcceptAndSubmitDealTBA"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 May 2024 13:37:31 GMT"},{"key":"Content-Length","value":"172"}],"cookie":[],"responseTime":null,"body":"{\n \"DealId\": null,\n \"DealNumber\": null,\n \"ErrorCode\": 10005,\n \"ErrorMessage\": \"Exception caught:Main Request; Exception: Object cannot be cast from DBNull to other types.\",\n \"QuoteID\": 0\n}"}],"_postman_id":"05283559-fc4e-4ef5-9b49-87a667b5e85c"},{"name":"SubmitDeal_0_0_1","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","packages":{},"id":"e2119f5d-68b3-45f5-bf50-1c6a1ac6bca4"}}],"id":"6bccec65-f204-46bd-b013-f0d93f894af6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"MethodID\": \"AFXEWSSD\",\r\n\"OrgID\": \"{{OrgID}}\",\r\n\"SettlementMethod\":\"holdingac\",\r\n\"SettlementAccountID\":2974,\r\n\"PaymentDetail\":\r\n [\r\n {\r\n \"Direction\": 0,\r\n \"Fee\": 0.0,\r\n \"FxAmount\": 1.0,\r\n \"FxCurrencyID\": \"USD\",\r\n \"InternalNotes\": \"intnot\",\r\n \"NotesToPayee\": \"pnot\",\r\n \"payee\":\r\n {\r\n \"OriginatorAccountNumber\": \"12345\",\r\n \"OriginatorAddress1\": \"OriginatorAddress1\",\r\n \"OriginatorAddress2\": \"A2\",\r\n \"OriginatorCity\": \"C\",\r\n \"OriginatorCountryID\": \"US\",\r\n \"OriginatorID\": null,\r\n \"OriginatorName\": \"OriginatorName\",\r\n \"OriginatorPostalCode\": \"PC\",\r\n \"OriginatorProvince\": \"D\",\r\n \"OriginatorType\": 0,\r\n \"PayeeAccountIBANNumber\": \"PayeeAccountIBANNumber\",\r\n \"PayeeAddress1\": \"PayeeAddress1\",\r\n \"PayeeAddress2\": \"PayeeAddress2\",\r\n \"PayeeBankAddress1\": \"PayeeBankAddress1\",\r\n \"PayeeBankAddress2\": \"PayeeBankAddress2\",\r\n \"PayeeBankBankCode\": \"323\",\r\n \"PayeeBankCity\": \"PayeeBankCity\",\r\n \"PayeeBankCountryID\": \"US\",\r\n \"PayeeBankName\": \"PayeeBankName\",\r\n \"PayeeBankPostalCode\": \"PV\",\r\n \"PayeeBankProvince\": \"PayeeBankProvince\",\r\n \"PayeeBankRoutingCode\": \"12345678\",\r\n \"PayeeBankRoutingType\": \"wire\",\r\n \"PayeeBankSwiftCode\": \"AAANNNHH\",\r\n \"PayeeCity\": \"PayeeCity\",\r\n \"PayeeCountryID\": \"US\",\r\n \"PayeeEmail\": \"a@a.com\",\r\n \"PayeeID\": 0,\r\n \"PayeeInterBankAddress1\": \"PayeeInterBankAddress1\",\r\n \"PayeeInterBankAddress2\": \"PayeeInterBankAddress2\",\r\n \"PayeeInterBankBankCode\": \"FTY\",\r\n \"PayeeInterBankCity\": \"PayeeInterBankCity\",\r\n \"PayeeInterBankCountryID\": \"US\",\r\n \"PayeeInterBankName\": \"PayeeInterBankName\",\r\n \"PayeeInterBankPostalCode\": \"e\",\r\n \"PayeeInterBankProvince\": \"PayeeInterBankProvince\",\r\n \"PayeeInterBankRoutingCode\": \"11111111\",\r\n \"PayeeInterBankRoutingCodeType\": \"swift\",\r\n \"PayeeName\": \"General Dymamics Gmbh\",\r\n \"PayeePostalCode\": \"q\",\r\n \"PayeeProvince\": \"PayeeProvince\",\r\n \"PayeeReference\": \"PayeeReference\",\r\n \"PayeeSendingBankInstructions\": \"Tax ID Payee Contact Info Other Information Here\"\r\n },\r\n \"PaymentMethod\": \"wire\",\r\n \"PaymentSequenceNo\": 1,\r\n \"Rate\": 1.0,\r\n \"SettlementAmount\": 1.0,\r\n \"SettlementCurrencyID\": \"USD\",\r\n \"TotalSettlementAmount\": 1.0\r\n\r\n }\r\n ],\r\n\"QuoteID\": 2750780,\r\n\"TotalNumberOfPayment\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/SubmitDeal_0_0_1","description":"

Request

\n

Sr.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

\n\n
    \n

  • StartFragmentSee appendix for samples on swift and routing code entries.

    \n
    • \n

  • This method will decline a response if the account is not cleared by compliance. Message
    provided = “Validation Error- Client is not allowed to transact\".EndFragment

    \n
    • \n
\n

Response

\n

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

 

 

 

 

 

\n\n

AUTO BANK LOOKUP & POPULATION
This is only available for Payment Method = EFT or Account Number = IBAN

\n","urlObject":{"path":["api","SubmitDeal_0_0_1"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"92c425fc-0f49-4dd7-91a1-f8a50b5d5be9","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"MethodID\": \"AFXEWSSD\",\r\n\"OrgID\": \"1871761\",\r\n\"SettlementMethod\":\"holdingac\",\r\n\"SettlementAccountID\":2974,\r\n\"PaymentDetail\":\r\n [\r\n {\r\n \"Direction\": 0,\r\n \"Fee\": 0.0,\r\n \"FxAmount\": 1.0,\r\n \"FxCurrencyID\": \"USD\",\r\n \"InternalNotes\": \"intnot\",\r\n \"NotesToPayee\": \"pnot\",\r\n \"payee\":\r\n {\r\n \"OriginatorAccountNumber\": \"12345\",\r\n \"OriginatorAddress1\": \"OriginatorAddress1\",\r\n \"OriginatorAddress2\": \"A2\",\r\n \"OriginatorCity\": \"C\",\r\n \"OriginatorCountryID\": \"US\",\r\n \"OriginatorID\": null,\r\n \"OriginatorName\": \"OriginatorName\",\r\n \"OriginatorPostalCode\": \"PC\",\r\n \"OriginatorProvince\": \"D\",\r\n \"OriginatorType\": 0,\r\n \"PayeeAccountIBANNumber\": \"PayeeAccountIBANNumber\",\r\n \"PayeeAddress1\": \"PayeeAddress1\",\r\n \"PayeeAddress2\": \"PayeeAddress2\",\r\n \"PayeeBankAddress1\": \"PayeeBankAddress1\",\r\n \"PayeeBankAddress2\": \"PayeeBankAddress2\",\r\n \"PayeeBankBankCode\": \"323\",\r\n \"PayeeBankCity\": \"PayeeBankCity\",\r\n \"PayeeBankCountryID\": \"US\",\r\n \"PayeeBankName\": \"PayeeBankName\",\r\n \"PayeeBankPostalCode\": \"PV\",\r\n \"PayeeBankProvince\": \"PayeeBankProvince\",\r\n \"PayeeBankRoutingCode\": \"12345678\",\r\n \"PayeeBankRoutingType\": \"wire\",\r\n \"PayeeBankSwiftCode\": \"AAANNNHH\",\r\n \"PayeeCity\": \"PayeeCity\",\r\n \"PayeeCountryID\": \"US\",\r\n \"PayeeEmail\": \"a@a.com\",\r\n \"PayeeID\": 0,\r\n \"PayeeInterBankAddress1\": \"PayeeInterBankAddress1\",\r\n \"PayeeInterBankAddress2\": \"PayeeInterBankAddress2\",\r\n \"PayeeInterBankBankCode\": \"FTY\",\r\n \"PayeeInterBankCity\": \"PayeeInterBankCity\",\r\n \"PayeeInterBankCountryID\": \"US\",\r\n \"PayeeInterBankName\": \"PayeeInterBankName\",\r\n \"PayeeInterBankPostalCode\": \"e\",\r\n \"PayeeInterBankProvince\": \"PayeeInterBankProvince\",\r\n \"PayeeInterBankRoutingCode\": \"11111111\",\r\n \"PayeeInterBankRoutingCodeType\": \"swift\",\r\n \"PayeeName\": \"General Dymamics Gmbh\",\r\n \"PayeePostalCode\": \"q\",\r\n \"PayeeProvince\": \"PayeeProvince\",\r\n \"PayeeReference\": \"PayeeReference\",\r\n \"PayeeSendingBankInstructions\": \"Tax ID Payee Contact Info Other Information Here\"\r\n },\r\n \"PaymentMethod\": \"wire\",\r\n \"PaymentSequenceNo\": 1,\r\n \"Rate\": 1.0,\r\n \"SettlementAmount\": 1.0,\r\n \"SettlementCurrencyID\": \"USD\",\r\n \"TotalSettlementAmount\": 1.0\r\n\r\n }\r\n ],\r\n\"QuoteID\": 2750780,\r\n\"TotalNumberOfPayment\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://afxlink-staging.ascendantfx.com/api/SubmitDeal_0_0_1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 05 Jul 2024 07:50:59 GMT"},{"key":"Content-Length","value":"1799"}],"cookie":[],"responseTime":null,"body":"{\n \"DealID\": \"3018472\",\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"PaymentDetail\": [\n {\n \"Direction\": 0,\n \"Fee\": 0,\n \"FxAmount\": 1,\n \"FxCurrencyID\": \"USD\",\n \"InternalNotes\": \"intnot\",\n \"NotesToPayee\": \"pnot\",\n \"PaymentMethod\": \"wire\",\n \"PaymentSequenceNo\": 1,\n \"Rate\": 1,\n \"SettlementAmount\": 1,\n \"SettlementCurrencyID\": \"USD\",\n \"TotalSettlementAmount\": 1,\n \"payee\": {\n \"OriginatorAccountNumber\": \"12345\",\n \"OriginatorAddress1\": \"OriginatorAddress1\",\n \"OriginatorAddress2\": \"A2\",\n \"OriginatorCity\": \"C\",\n \"OriginatorCountryID\": \"US\",\n \"OriginatorID\": null,\n \"OriginatorName\": \"OriginatorName\",\n \"OriginatorPostalCode\": \"PC\",\n \"OriginatorProvince\": \"D\",\n \"OriginatorType\": 0,\n \"PayeeAccountIBANNumber\": \"PAYEEACCOUNTIBANNUMBER\",\n \"PayeeAddress1\": \"PayeeAddress1\",\n \"PayeeAddress2\": \"PayeeAddress2\",\n \"PayeeBankAddress1\": \"PayeeBankAddress1\",\n \"PayeeBankAddress2\": \"PayeeBankAddress2\",\n \"PayeeBankBankCode\": \"323\",\n \"PayeeBankCity\": \"PayeeBankCity\",\n \"PayeeBankCountryID\": \"US\",\n \"PayeeBankName\": \"PayeeBankName\",\n \"PayeeBankPostalCode\": \"PV\",\n \"PayeeBankProvince\": \"PayeeBankProvince\",\n \"PayeeBankRoutingCode\": \"12345678\",\n \"PayeeBankRoutingType\": \"wire\",\n \"PayeeBankSwiftCode\": \"12345678\",\n \"PayeeCity\": \"PayeeCity\",\n \"PayeeCountryID\": \"US\",\n \"PayeeEmail\": \"a@a.com\",\n \"PayeeID\": 0,\n \"PayeeInterBankAddress1\": \"PayeeInterBankAddress1\",\n \"PayeeInterBankAddress2\": \"PayeeInterBankAddress2\",\n \"PayeeInterBankBankCode\": \"FTY\",\n \"PayeeInterBankCity\": \"PayeeInterBankCity\",\n \"PayeeInterBankCountryID\": \"US\",\n \"PayeeInterBankName\": \"PayeeInterBankName\",\n \"PayeeInterBankPostalCode\": \"e\",\n \"PayeeInterBankProvince\": \"PayeeInterBankProvince\",\n \"PayeeInterBankRoutingCode\": \"11111111\",\n \"PayeeInterBankRoutingCodeType\": \"swift\",\n \"PayeeName\": \"General Dymamics Gmbh\",\n \"PayeePostalCode\": \"q\",\n \"PayeeProvince\": \"PayeeProvince\",\n \"PayeeReference\": \"PayeeReference\",\n \"PayeeSendingBankInstructions\": \"Tax ID Payee Contact Info Other Information Here\"\n }\n }\n ],\n \"TotalNumberOfPayment\": 1\n}"}],"_postman_id":"6bccec65-f204-46bd-b013-f0d93f894af6"}],"id":"02941601-ecf1-4ad4-978b-e7203cd389ed","_postman_id":"02941601-ecf1-4ad4-978b-e7203cd389ed","description":""},{"name":"Inquiry & Confirmation","item":[{"name":"GetAccountActivity_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":"b5837b2d-665a-41f1-b24b-425c34123cc2"}}],"id":"65d1e4f9-beb1-4c5e-95c9-11902d14a9a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSGAA\",\r\n \"AccountNumber\": \"0001855\",\r\n \"Factor\": 1,\r\n \"Month\": 2,\r\n \"Year\": 2023,\r\n \"Days\": 2,\r\n \"TransactionType\": 0,\r\n \"DealId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/GetAccountActivity_0_0_2","description":"

Request

\n

Sr.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
1 - Records from Today
2 – Today and Yesterday
3 - Today, Yesterday and the Day Before
N – Last N days
8
Transaction Type
Integer
0 to 2
0 – will get both Credit and Debit
records
1 – will get all Credit records
2 – will get all Debit records
9
DealID
Alpha Numeric
Two Formats Possible
(Sample) Values. Response
will be in one of the two
format
c. AFX US-DEAL -123456
d. 576918
\n\n

Response

\n

Sr.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
number of transactions in the
array

4

AccountNumber

 Same as in request

5

Factor
Integer

 Same as in request

 

6
Month
Integer
Same as in request
7
Year
Integer
Same as in request
8
Days
Integer
9
DealId
Integer
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
DealID
integer
10.7
TransactionType
Alpha numeric
15,9
","urlObject":{"path":["api","GetAccountActivity_0_0_2"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"9ea1dc22-0112-4797-8c15-8ba835ce836e","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"1871761\",\r\n \"MethodID\": \"AFXEWSGAA\",\r\n \"AccountNumber\": \"0002029\",\r\n \"Factor\": 1,\r\n \"Month\": 2,\r\n \"Year\": 2023,\r\n \"Days\": 2,\r\n \"TransactionType\": 0,\r\n \"DealId\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://afxlink-staging.ascendantfx.com/api/GetAccountActivity_0_0_1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 09 Nov 2023 10:17:40 GMT"},{"key":"Content-Length","value":"640"}],"cookie":[],"responseTime":null,"body":"{\n \"AccountNumber\": \"0002029\",\n \"Days\": 2,\n \"DealId\": \"\",\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"Factor\": 1,\n \"Month\": 2,\n \"NumberOfTransaction\": 2,\n \"Transaction\": [\n {\n \"DealId\": \"\",\n \"Deposit\": 0,\n \"Narration\": \"ACH | AFX US-DEAL-3912345 | ClientName | Comp USA Inc.\",\n \"TransactionDate\": \"2023-02-06 12:00:00 AM\",\n \"TransactionSequenceNo\": 1,\n \"TransactionType\": \"Debit\",\n \"Withdrawal\": 2213\n },\n {\n \"DealId\": \" 2299159\",\n \"Deposit\": 2212.99999999999,\n \"Narration\": \"Settlement From Deal No 2299159\",\n \"TransactionDate\": \"2023-02-06 12:00:00 AM\",\n \"TransactionSequenceNo\": 2,\n \"TransactionType\": \"Credit\",\n \"Withdrawal\": 0\n }\n ],\n \"TransactionType\": 0,\n \"Year\": 2023\n}"}],"_postman_id":"65d1e4f9-beb1-4c5e-95c9-11902d14a9a1"},{"name":"GetPaymentStatus","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":"e7a888a7-42e1-42cc-82d6-52373479a3c2"}}],"id":"ac6d2b65-7f6e-4406-b855-4019222b5b03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"PaymentID\": \"1298700\",\r\n \"MethodID\": \"AFXEWSGPS\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/GetPaymentStatus","urlObject":{"path":["api","GetPaymentStatus"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"1ecb7111-84ab-41d7-895f-635ee2dc2998","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"1871761\",\r\n \"PaymentID\": \"4023705\",\r\n \"MethodID\": \"AFXEWSGPS\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://afxlink-staging.ascendantfx.com/api/GetPaymentStatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 13 Jun 2024 10:47:30 GMT"},{"key":"Content-Length","value":"1248"}],"cookie":[],"responseTime":null,"body":"{\n \"CurrentPaymentStatus\": \"In Progress\",\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"PayeeName\": \"XYZ Test Company Inc\",\n \"PaymentAmount\": 1,\n \"PaymentCurrency\": \"USD\",\n \"PaymentMethod\": \"Wire\",\n \"PaymentTrackerInfo\": [\n {\n \"BankBICCode\": \"\",\n \"Currency\": \"USD\",\n \"CustomerName\": \"\",\n \"Duration\": \"\",\n \"ETA\": \"\",\n \"Fees\": \"\",\n \"PayeeBankAddress\": \"150 King St. W., Suite 1902 Toronto, ON M5H 1J9 Canada\",\n \"PayeeBankCity\": \"Toronto\",\n \"PayeeBankCountry\": \"\",\n \"PayeeBankName\": \"ASCENDANT\",\n \"PayeeName\": \"XYZ Test Company Inc\",\n \"ReceivedAmount\": \"1.00\",\n \"RelationshipManager\": \"\",\n \"SendAmount\": \"1.00 USD\",\n \"Status\": \"In Progress\",\n \"StatusCode\": \"NGPI002\",\n \"StatusUpdatedDate\": \"2024-02-26 7:44:57 AM\",\n \"SwiftMessage\": \"\",\n \"SwiftTrackingNumber\": \"\",\n \"TrackerInfoID\": 2\n },\n {\n \"BankBICCode\": \"\",\n \"Currency\": \"USD\",\n \"CustomerName\": \"\",\n \"Duration\": \"\",\n \"ETA\": \"\",\n \"Fees\": \"\",\n \"PayeeBankAddress\": \"150 King St. W., Suite 1902 Toronto, ON M5H 1J9 Canada\",\n \"PayeeBankCity\": \"Toronto\",\n \"PayeeBankCountry\": \"\",\n \"PayeeBankName\": \"ASCENDANT\",\n \"PayeeName\": \"XYZ Test Company Inc\",\n \"ReceivedAmount\": \"1.00\",\n \"RelationshipManager\": \"\",\n \"SendAmount\": \"1.00 USD\",\n \"Status\": \"Initiated\",\n \"StatusCode\": \"NGPI001\",\n \"StatusUpdatedDate\": \"2024-02-26 7:44:57 AM\",\n \"SwiftMessage\": \"\",\n \"SwiftTrackingNumber\": \"\",\n \"TrackerInfoID\": 1\n }\n ],\n \"StatusUpdatedDate\": \"/Date(1708951497673-0500)/\"\n}"}],"_postman_id":"ac6d2b65-7f6e-4406-b855-4019222b5b03"},{"name":"GetAccountBalance_0_0_1","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","packages":{},"id":"b4f0c5f7-f1fb-4340-af0d-340a14183118"}}],"id":"73c80062-d4a2-443b-b6d5-d186bb28e274","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"1871761\",\r\n \"MethodID\": \"AFXEWSGAB\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/GetAccountBalance_0_0_2","description":"

Request

\n

Sr.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

\n\n

Response

\n

Sr.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
of accounts in the array

4

Account_0_0_1

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.1

AccountNumber

Alpha Numeric

 

 

4.2

AccountCurrencyID

Char

 

 

Like CAD,USD

4.3

BalanceAmount

Number

 15,9

 

","urlObject":{"path":["api","GetAccountBalance_0_0_2"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"3d95f875-c0c6-4c03-8a0e-5987716b042d","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"1871761\",\r\n \"MethodID\": \"AFXEWSGAB\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://afxlink-staging.ascendantfx.com/api/GetAccountBalance_0_0_1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 May 2024 11:49:19 GMT"},{"key":"Content-Length","value":"651"}],"cookie":[],"responseTime":null,"body":"{\n \"Account\": [\n {\n \"AccountCurrencyID\": \"CAD\",\n \"AccountID\": \"2972\",\n \"AccountNumber\": \"0001853\",\n \"BalanceAmount\": 97.9100000000035\n },\n {\n \"AccountCurrencyID\": \"USD\",\n \"AccountID\": \"2974\",\n \"AccountNumber\": \"0001855\",\n \"BalanceAmount\": 0.990000000048894\n },\n {\n \"AccountCurrencyID\": \"GBP\",\n \"AccountID\": \"3132\",\n \"AccountNumber\": \"0002013\",\n \"BalanceAmount\": 0\n },\n {\n \"AccountCurrencyID\": \"EUR\",\n \"AccountID\": \"3133\",\n \"AccountNumber\": \"0002014\",\n \"BalanceAmount\": 0\n },\n {\n \"AccountCurrencyID\": \"AUD\",\n \"AccountID\": \"3188\",\n \"AccountNumber\": \"0002069\",\n \"BalanceAmount\": 0\n },\n {\n \"AccountCurrencyID\": \"CAD\",\n \"AccountID\": \"4064\",\n \"AccountNumber\": \"0002791\",\n \"BalanceAmount\": 2\n }\n ],\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"NumberOfAccount\": \"6\"\n}"}],"_postman_id":"73c80062-d4a2-443b-b6d5-d186bb28e274"},{"name":"GetFundingAccountList","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","packages":{},"id":"aa6a7947-968a-41cd-8458-c1b2a4a01c52"}}],"id":"d6db7df6-3e75-4601-8cf2-599c6657ac29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSGAB\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/GetFundingAccountList\n","description":"

Request

\n

Sr.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

\n\n

Response

\n

Sr.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”
","urlObject":{"path":["api","GetFundingAccountList\n"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"dfffa694-7036-451d-a909-40c517db4967","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSGAB\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/GetAccountBalance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 09 Nov 2023 10:09:54 GMT"},{"key":"Content-Length","value":"247"}],"cookie":[],"responseTime":null,"body":"{\n \"Account\": [\n {\n \"AccountCurrencyID\": \"EUR\",\n \"AccountNumber\": \"0001752\",\n \"BalanceAmount\": 1036.6400000155\n },\n {\n \"AccountCurrencyID\": \"USD\",\n \"AccountNumber\": \"0002029\",\n \"BalanceAmount\": 4708.56999999285\n }\n ],\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"NumberOfAccount\": \"2\"\n}"}],"_postman_id":"d6db7df6-3e75-4601-8cf2-599c6657ac29"}],"id":"f5a72427-1797-4e71-8951-dbc936d1ae0e","_postman_id":"f5a72427-1797-4e71-8951-dbc936d1ae0e","description":""},{"name":"Payee","item":[{"name":"AddPayee","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","packages":{},"id":"9fdb8dd7-f67b-4bc2-872e-bc1e1cb47ec5"}}],"id":"20e89ba0-717e-4285-88ba-d2eb1205974d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSPOA\",\r\n \"PayeeDetail\": [\r\n {\r\n \"PayeeID\": 0,\r\n \"PayeeName\": \"DemotestWire\",\r\n \"CurrencyID\": \"USD\",\r\n \"PaymentMethod\": \"wire\",\r\n \"PayeeAddress1\": \"test2\",\r\n \"PayeeAddress2\": \"\",\r\n \"PayeeCity\": \"\",\r\n \"PayeeProvince\": \"\",\r\n \"PayeeCountryID\": \"GB\",\r\n \"PayeePostalCode\": \"\",\r\n \"PayeeBankName\": \"test\",\r\n \"PayeeBankAddress1\": \"\",\r\n \"PayeeBankAddress2\": \"\",\r\n \"PayeeBankCity\": \"\",\r\n \"PayeeBankProvince\": \"\",\r\n \"PayeeBankCountryID\": \"GB\",\r\n \"PayeeBankPostalCode\": \"\",\r\n \"PayeeAccountIBANNumber\": \"1234\",\r\n \"PayeeBankRoutingType\": \"wire\",\r\n \"PayeeBankRoutingCode\": \"12345678\",\r\n \"PayeeBankBankCode\": \"212\",\r\n \"PayeeBankSwiftCode\": null,\r\n \"PayeeInterBankName\": \"\",\r\n \"PayeeInterBankAddress1\": \"\",\r\n \"PayeeInterBankAddress2\": \"\",\r\n \"PayeeInterBankCity\": \"\",\r\n \"PayeeInterBankProvince\": \"\",\r\n \"PayeeInterBankCountryID\": \"\",\r\n \"PayeeInterBankPostalCode\": \"\",\r\n \"PayeeInterBankRoutingCodeType\": \"\",\r\n \"PayeeInterBankRoutingCode\": \"\",\r\n \"PayeeInterBankBankCode\": \"555\",\r\n \"PayeeReference\": \"\",\r\n \"PayeeEmail\": \"\",\r\n \"OriginatorID\": null,\r\n \"OriginatorName\": \"\",\r\n \"OriginatorAddress1\": \"\",\r\n \"OriginatorAddress2\": \"\",\r\n \"OriginatorCity\": \"\",\r\n \"OriginatorProvince\": \"\",\r\n \"OriginatorCountryID\": \"\",\r\n \"OriginatorPostalCode\": \"\",\r\n \"OriginatorType\": 0,\r\n \"OriginatorAccountNumber\": \"\",\r\n \"PayeeSendingBankInstructions\": \"instruction here\",\r\n \"PayeeInternalReference\": null\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/AddPayee","description":"

Request

\n

Sr.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

3.24

PayeeInterBankAddress1

Alpha Numeric

 

 

 

3.25

PayeeInterBankAddress2

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 

\n\n

Response

\n

Sr.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 newly created payee

 

Null if there was an error and payee was not created

4

PayeeName

Alpha Numeric

 

 

 

Null if there was an error and payee was not created

5.

PayeeInternalReference

Alpha Numeric

 

 

 

Null if there was an error and payee was not created

","urlObject":{"path":["api","AddPayee"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"f80e4389-00c0-4cb9-a207-d8e2d5a616d8","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSPOA\",\r\n \"PayeeDetail\": [\r\n {\r\n \"PayeeID\": 0,\r\n \"PayeeName\": \"DemotestWire\",\r\n \"CurrencyID\": \"USD\",\r\n \"PaymentMethod\": \"wire\",\r\n \"PayeeAddress1\": \"test2\",\r\n \"PayeeAddress2\": \"\",\r\n \"PayeeCity\": \"\",\r\n \"PayeeProvince\": \"\",\r\n \"PayeeCountryID\": \"GB\",\r\n \"PayeePostalCode\": \"\",\r\n \"PayeeBankName\": \"test\",\r\n \"PayeeBankAddress1\": \"\",\r\n \"PayeeBankAddress2\": \"\",\r\n \"PayeeBankCity\": \"\",\r\n \"PayeeBankProvince\": \"\",\r\n \"PayeeBankCountryID\": \"GB\",\r\n \"PayeeBankPostalCode\": \"\",\r\n \"PayeeAccountIBANNumber\": \"1234\",\r\n \"PayeeBankRoutingType\": \"wire\",\r\n \"PayeeBankRoutingCode\": \"12345678\",\r\n \"PayeeBankBankCode\": \"212\",\r\n \"PayeeBankSwiftCode\": null,\r\n \"PayeeInterBankName\": \"\",\r\n \"PayeeInterBankAddress1\": \"\",\r\n \"PayeeInterBankAddress2\": \"\",\r\n \"PayeeInterBankCity\": \"\",\r\n \"PayeeInterBankProvince\": \"\",\r\n \"PayeeInterBankCountryID\": \"\",\r\n \"PayeeInterBankPostalCode\": \"\",\r\n \"PayeeInterBankRoutingCodeType\": \"\",\r\n \"PayeeInterBankRoutingCode\": \"\",\r\n \"PayeeInterBankBankCode\": \"555\",\r\n \"PayeeReference\": \"\",\r\n \"PayeeEmail\": \"\",\r\n \"OriginatorID\": null,\r\n \"OriginatorName\": \"\",\r\n \"OriginatorAddress1\": \"\",\r\n \"OriginatorAddress2\": \"\",\r\n \"OriginatorCity\": \"\",\r\n \"OriginatorProvince\": \"\",\r\n \"OriginatorCountryID\": \"\",\r\n \"OriginatorPostalCode\": \"\",\r\n \"OriginatorType\": 0,\r\n \"OriginatorAccountNumber\": \"\",\r\n \"PayeeSendingBankInstructions\": \"instruction here\",\r\n \"PayeeInternalReference\": null\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/AddPayee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 May 2024 12:01:23 GMT"},{"key":"Content-Length","value":"116"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"PayeeId\": \"645474\",\n \"PayeeInternalReference\": null,\n \"PayeeName\": \"DemotestWire\"\n}"}],"_postman_id":"20e89ba0-717e-4285-88ba-d2eb1205974d"},{"name":"UpdatePayee","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":"3c6780a6-cc13-49ac-a6f3-ab97e4f94c4a"}}],"id":"07a6bd22-f9aa-4787-ab46-d778403078c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSPOE\",\r\n \"PayeeDetail\": [\r\n {\r\n \"PayeeID\": 643857,\r\n \"PayeeName\": \"DemotestWirePayee\",\r\n \"CurrencyID\": \"USD\",\r\n \"PaymentMethod\": \"wire\",\r\n \"PayeeAddress1\": \"test2\",\r\n \"PayeeAddress2\": \"\",\r\n \"PayeeCity\": \"\",\r\n \"PayeeProvince\": \"\",\r\n \"PayeeCountryID\": \"GB\",\r\n \"PayeePostalCode\": \"\",\r\n \"PayeeBankName\": \"test\",\r\n \"PayeeBankAddress1\": \"\",\r\n \"PayeeBankAddress2\": \"\",\r\n \"PayeeBankCity\": \"\",\r\n \"PayeeBankProvince\": \"\",\r\n \"PayeeBankCountryID\": \"GB\",\r\n \"PayeeBankPostalCode\": \"\",\r\n \"PayeeAccountIBANNumber\": \"1234\",\r\n \"PayeeBankRoutingType\": \"wire\",\r\n \"PayeeBankRoutingCode\": \"12345678\",\r\n \"PayeeBankBankCode\": \"212\",\r\n \"PayeeBankSwiftCode\": null,\r\n \"PayeeInterBankName\": \"\",\r\n \"PayeeInterBankAddress1\": \"\",\r\n \"PayeeInterBankAddress2\": \"\",\r\n \"PayeeInterBankCity\": \"\",\r\n \"PayeeInterBankProvince\": \"\",\r\n \"PayeeInterBankCountryID\": \"\",\r\n \"PayeeInterBankPostalCode\": \"\",\r\n \"PayeeInterBankRoutingCodeType\": \"\",\r\n \"PayeeInterBankRoutingCode\": \"\",\r\n \"PayeeInterBankBankCode\": \"555\",\r\n \"PayeeReference\": \"\",\r\n \"PayeeEmail\": \"\",\r\n \"OriginatorID\": null,\r\n \"OriginatorName\": \"\",\r\n \"OriginatorAddress1\": \"\",\r\n \"OriginatorAddress2\": \"\",\r\n \"OriginatorCity\": \"\",\r\n \"OriginatorProvince\": \"\",\r\n \"OriginatorCountryID\": \"\",\r\n \"OriginatorPostalCode\": \"\",\r\n \"OriginatorType\": 0,\r\n \"OriginatorAccountNumber\": \"\",\r\n \"PayeeSendingBankInstructions\": \"instruction here change\",\r\n \"PayeeInternalReference\": null\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/UpdatePayee","description":"

Request

\n

Sr.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

Payee Bank Name

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 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 

\n\n

Response

\n

Sr.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 newly created payee

 

Null if there was an error and payee was not created

4

PayeeName

Alpha Numeric

 

 

 

Null if there was an error and payee was not created

5.

PayeeInternalReference

Alpha Numeric

 

 

 

Null if there was an error and payee was not created

","urlObject":{"path":["api","UpdatePayee"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"7ff66c83-514d-411d-8b60-7ff842311d14","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSPOE\",\r\n \"PayeeDetail\": [\r\n {\r\n \"PayeeID\": 645647,\r\n \"PayeeName\": \"Test567\",\r\n \"CurrencyID\": \"USD\",\r\n \"PaymentMethod\": \"wire\",\r\n \"PayeeAddress1\": \"test2\",\r\n \"PayeeAddress2\": \"\",\r\n \"PayeeCity\": \"\",\r\n \"PayeeProvince\": \"\",\r\n \"PayeeCountryID\": \"GB\",\r\n \"PayeePostalCode\": \"\",\r\n \"PayeeBankName\": \"test\",\r\n \"PayeeBankAddress1\": \"\",\r\n \"PayeeBankAddress2\": \"\",\r\n \"PayeeBankCity\": \"\",\r\n \"PayeeBankProvince\": \"\",\r\n \"PayeeBankCountryID\": \"GB\",\r\n \"PayeeBankPostalCode\": \"\",\r\n \"PayeeAccountIBANNumber\": \"1234\",\r\n \"PayeeBankRoutingType\": \"wire\",\r\n \"PayeeBankRoutingCode\": \"12345678\",\r\n \"PayeeBankBankCode\": \"212\",\r\n \"PayeeBankSwiftCode\": null,\r\n \"PayeeInterBankName\": \"\",\r\n \"PayeeInterBankAddress1\": \"\",\r\n \"PayeeInterBankAddress2\": \"\",\r\n \"PayeeInterBankCity\": \"\",\r\n \"PayeeInterBankProvince\": \"\",\r\n \"PayeeInterBankCountryID\": \"\",\r\n \"PayeeInterBankPostalCode\": \"\",\r\n \"PayeeInterBankRoutingCodeType\": \"\",\r\n \"PayeeInterBankRoutingCode\": \"\",\r\n \"PayeeInterBankBankCode\": \"555\",\r\n \"PayeeReference\": \"\",\r\n \"PayeeEmail\": \"\",\r\n \"OriginatorID\": null,\r\n \"OriginatorName\": \"\",\r\n \"OriginatorAddress1\": \"\",\r\n \"OriginatorAddress2\": \"\",\r\n \"OriginatorCity\": \"\",\r\n \"OriginatorProvince\": \"\",\r\n \"OriginatorCountryID\": \"\",\r\n \"OriginatorPostalCode\": \"\",\r\n \"OriginatorType\": 0,\r\n \"OriginatorAccountNumber\": \"\",\r\n \"PayeeSendingBankInstructions\": \"instruction here change\",\r\n \"PayeeInternalReference\": null\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/UpdatePayee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 13 Jun 2024 10:29:10 GMT"},{"key":"Content-Length","value":"120"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"PayeeId\": \"645647\",\n \"PayeeInternalReference\": \"Test567-USD\",\n \"PayeeName\": \"Test567\"\n}"}],"_postman_id":"07a6bd22-f9aa-4787-ab46-d778403078c1"},{"name":"DeletePayee","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":"e0a9eb5e-2ddb-42a4-8477-8d7d691003cc"}}],"id":"af6974f2-7b1e-49a6-898e-ef9579719044","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSPOD\",\r\n \"PayeeDetail\": [\r\n {\r\n \"PayeeID\": 643863,\r\n \"PaymentMethod\": \"wire\"\r\n \r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/DeletePayee","description":"

Request

\n

Sr.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 

\n\n

Response

\n

Sr.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 newly created payee

 

Null if there was an error and payee was not created

4

PayeeName

Alpha Numeric

 

 

 

Null if there was an error and payee was not created

5.

PayeeInternalReference

Alpha Numeric

 

 

 

Null if there was an error and payee was not created

","urlObject":{"path":["api","DeletePayee"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"bda40de1-1d17-4ae1-a391-b9225a2e0620","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSPOD\",\r\n \"PayeeDetail\": [\r\n {\r\n \"PayeeID\": 645647,\r\n \"PaymentMethod\": \"wire\"\r\n \r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/DeletePayee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 13 Jun 2024 10:29:44 GMT"},{"key":"Content-Length","value":"120"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"PayeeId\": \"645647\",\n \"PayeeInternalReference\": \"Test567-USD\",\n \"PayeeName\": \"Test567\"\n}"}],"_postman_id":"af6974f2-7b1e-49a6-898e-ef9579719044"}],"id":"ed17f92b-f73f-4313-b54c-776ff912579d","_postman_id":"ed17f92b-f73f-4313-b54c-776ff912579d","description":""},{"name":"Validation","item":[{"name":"ValidateIBAN","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":"fe6ca291-3d93-4aeb-80ca-a2c8ef2bd2df"}}],"id":"da9fcdf8-1bda-4766-b8f7-70cae454fd12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{APIUsername}}"},{"key":"password","value":"{{APIPassword}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSVIBN\",\r\n \"IBANNumber\": \"IT70J062256243010000000445\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/ValidateIBAN","description":"

Request

\n

Sr.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

IBANNumber

Alpha Numeric

15

 not null

Provide the
IBAN # to
Validate
\n\n

Response

\n

Sr.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
","urlObject":{"path":["api","ValidateIBAN"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"037641de-0e7f-435e-80ca-5646b85af4cf","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrgID\": \"{{OrgID}}\",\r\n \"MethodID\": \"AFXEWSVIBN\",\r\n \"IBANNumber\": \"EG600002077007700200000000377\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseURL}}/api/ValidateIBAN"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 13 Jun 2024 10:38:22 GMT"},{"key":"Content-Length","value":"313"}],"cookie":[],"responseTime":null,"body":"{\n \"Address\": \"X\",\n \"BankName\": \"BANQUE MISR\",\n \"BeneficiaryBankCode\": \"XXX\",\n \"BeneficiaryBankCountryId\": null,\n \"BeneficiaryBankRoutingCode\": null,\n \"City\": \"X\",\n \"Country\": null,\n \"CountryCode\": \"EG\",\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"Success\",\n \"IBANNumber\": \"700200000000377\",\n \"RoutingCode\": \"BMISEGCX\",\n \"SwiftCode\": \"BMISEGCXXXX\",\n \"Valid\": true\n}"}],"_postman_id":"da9fcdf8-1bda-4766-b8f7-70cae454fd12"}],"id":"54107305-385f-4713-9882-59aab3db6d70","_postman_id":"54107305-385f-4713-9882-59aab3db6d70","description":""},{"name":"New Request","id":"bc8def81-1bf9-497c-bdbf-2620518372e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"bc8def81-1bf9-497c-bdbf-2620518372e8"}]}