Thanks to visit codestin.com
Credit goes to www.scribd.com

0% found this document useful (0 votes)
23 views7 pages

API Documentation

The API documentation outlines the process for managing payment orders, including retrieving lists of transactions and confirming reservations. It details the transaction lifecycle states from PREPARED to BOOKED, as well as the necessary request and response parameters for GET and PUT requests. Additionally, it specifies the required authorization and the structure of the response data for successful transactions.

Uploaded by

azamix
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
23 views7 pages

API Documentation

The API documentation outlines the process for managing payment orders, including retrieving lists of transactions and confirming reservations. It details the transaction lifecycle states from PREPARED to BOOKED, as well as the necessary request and response parameters for GET and PUT requests. Additionally, it specifies the required authorization and the structure of the response data for successful transactions.

Uploaded by

azamix
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 7

API Documentation

Transactions
Get the list of payment orders based on the search parameters. The user also requires
corresponding read privileges for the customer account. If a combination of filter parameters are
applied, only orders that match all of the conditions are returned.

Here is a brief overview of the transaction state lifecycle:

PREPARED: After a transaction is created via the API, it enters the PREPARED state,
indicating it is ready for further processing.

IN_PROGRESS: When the transaction is signed, it moves to the IN_PROGRESS state,


meaning it is being processed.

EXECUTED: If the transaction is successfully processed, it moves to the EXECUTED state.

BOOKED/RECONCILED/SETTLED: After the transaction is fully processed and finalized by the


core banking system, it reaches the BOOKED state. BOOKED is the final state and it cannot
change afterwards.

REJECTED: A transaction can be marked as REJECTED if it is deleted by the user or rejected


by the bank.
GET

GET /v2/reservations/

GET /v2/reservations/<Reservation Id>


Get the list of payment orders based on the search parameters. The user also requires
corresponding read privileges for the customer account.

If a combination of filter parameters are applied, only orders that match all of the conditions are
returned.

Request Parameters

GET
https://my.ftassetmanagement.com/api/reservation/<Reservation-key>
Content-Type: application/json
Accept: application/json
Authorization: ...

...

Name Type Description Default Constraints

Authorization header Bearer <token>

Response

{
​ "ReservationsOverview 0.9" : {
​ "Name": "test",
​ "Country": "TEST",
​ "Website": "FTAssetManagement.com",
​ "NumberOfRecords": "6",
"Details": {
"RecordNumber": "1",
"AuthToken": "3f299423-e046-11ec-947e-00155d010b18",
"TransactionURL":
"http://my2.ftassetmanagement.com/api/reservation.asp?key=f05bb4df-d8f8-11ef-a3af-00155d010b
18&Res_code=2bda29da-da8b-11ef-a3af-00155d010b18",
"AccountName": "Most Investment B.V.",
"AccountSignatory": "Mr. Jan Jaap van der Most",
"Amount": "74300000000",
"Currency": "USD"
},
"Details": {
"RecordNumber": "2",
"AuthToken": "3f299423-e046-11ec-947e-00155d010b18",
"TransactionURL":
"http://my2.ftassetmanagement.com/api/reservation.asp?key=f05bb4df-d8f8-11ef-a3af-00155d010b
18&Res_code=2ed46513-da8b-11ef-a3af-00155d010b18",
"AccountName": "Most Investment B.V.",
"AccountSignatory": "Mr. Jan Jaap van der Most",
"Amount": "74300000000",
"Currency": "USD"
},
"Details": {
"RecordNumber": "3",
"AuthToken": "3f299423-e046-11ec-947e-00155d010b18",
"TransactionURL":
"http://my2.ftassetmanagement.com/api/reservation.asp?key=f05bb4df-d8f8-11ef-a3af-00155d010b
18&Res_code=32515e20-da8b-11ef-a3af-00155d010b18",
"AccountName": "Most Investment B.V.",
"AccountSignatory": "Mr. Jan Jaap van der Most",
"Amount": "216600000000",
"Currency": "USD"
},
"Details": {
"RecordNumber": "4",
"AuthToken": "3f299423-e046-11ec-947e-00155d010b18",
"TransactionURL":
"http://my2.ftassetmanagement.com/api/reservation.asp?key=f05bb4df-d8f8-11ef-a3af-00155d010b
18&Res_code=35a4c1cc-da8b-11ef-a3af-00155d010b18",
"AccountName": "Most Investment B.V.",
"AccountSignatory": "Mr. Jan Jaap van der Most",
"Amount": "100000000",
"Currency": "USD"
},
"Details": {
"RecordNumber": "5",
"AuthToken": "3f2b1ca5-e046-11ec-947e-00155d010b18",
"TransactionURL":
"http://my2.ftassetmanagement.com/api/reservation.asp?key=f05bb4df-d8f8-11ef-a3af-00155d010b
18&Res_code=3957edb2-da8b-11ef-a3af-00155d010b18",
"AccountName": "",
"AccountSignatory": "Mr. FEDERICA BETTANIN",
"Amount": "29300",
"Currency": "EUR"
},
"Details": {
"RecordNumber": "6",
"AuthToken": "3f299423-e046-11ec-947e-00155d010b18",
"TransactionURL":
"http://my2.ftassetmanagement.com/api/reservation.asp?key=f05bb4df-d8f8-11ef-a3af-00155d010b
18&Res_code=3cf3898f-da8b-11ef-a3af-00155d010b18",
"AccountName": "Most Investment B.V.",
"AccountSignatory": "Mr. Jan Jaap van der Most",
"Amount": "29300",
"Currency": "EUR"
}
}
}
Response Parameters

Name Type Description Default Constraints

RecordNumber Char Unique sequence number Primary


within the Details group Key2

AuthToken Char Bearer <token> for each Primary


transaction Key1

TransactionURL Char Endpoint for transaction


execution

AccountName Char Account holder name

AccountSignitory Char Account signitory name

Amount Number Transactional amount

Currency Char Currency code of the


transaction

Response Codes
PUT

PUT /v2/ReservationConfirmation/<ReservationId>/<ConfirmationId>
Insert payment orders based on the Confirmation parameters. The user also requires
corresponding read and write privileges for the customer account.

If a combination of filter parameters are applied, only orders that match all of the conditions are
written into the database.

Request Parameters

PUT
https://my.ftassetmanagement.com/api/ReservationConfirmation/<Reser
vation-Key>/<transaction-key>/
Content-Type: application/json
Accept: application/json
Authorization: ...

...

Name Type Description Default Constraints

Authorization header Bearer <token>

Authorization header Transaction-Key <token>

Response
{
​ "ReservationsDetail 0.9" : {
​ "Name": "test",
​ "Country": "TEST",
​ "Website": "FTAssetManagement.com",
"Details": {
"AuthToken": "3957edb2-da8b-11ef-a3af-00155d010b18",
"TransactionURL":
"http://my2.ftassetmanagement.com/api/reservation.asp?key=f05bb4df-d8f8-11ef-a3af-00155d010b
18&Res_code=3957edb2-da8b-11ef-a3af-00155d010b18",
"AccountName": "",
"AccountSignatory": "Mr. FEDERICA BETTANIN",
"AccountNumber": "Mr. FEDERICA BETTANIN",
"Amount": "29300",
"Currency": "EUR",
"CashTransfer.v1": {
"SendingName": "Mr. FEDERICA BETTANIN",
"SendingAccount": "40336",
"ReceivingName": "Mr. FEDERICA BETTANIN",
"ReceivingSignatory": "Mr. FEDERICA BETTANIN",
"ReceivingAccount": "42042",
"Datetime": "22-1-2025 16:34:21",
"Amount": "29300",
"ReceivingCurrency": "EUR",
"SendingCurrency": "EUR",
"Description": "REJECTED WIRE MOTORVILLAGE LLC NO CURRENCY CORRESPONDANCE",
"TransferRequestID": "43717",
"ReceivingInstitution": "test",
"SendingInstitution": "FT Asset Management KB"
}
}
}
}

Name Type Description Default Constraints

AuthToken Char Bearer <token> for each Primary


transaction Key2

TransactionURL Char Endpoint for transaction


execution

AccountName Char Account holder name

AccountSignitory Char Account signatory name

AccountNumber Char Account Number of the


party for Debit in the
Banks ledger of the client

Amount Number Transactional amount

Currency Char Currency code of the


transaction

DateTime Date/Time Timestamp when the


transaction was initiated

SendingName Char Senders name/Institution


Name

SendingAccount Char Senders Account

SendingIBAN Char Senders Temporary IBAN Optional


if mapped

SendingInstitution Char Senders Institution if Optional


Mapped to a
corresponding bank

SendingBIC Char Sending Bank SWIFT if


mapped to a SWIFT
institution

CorresBIC Char SWIFT Code of the Optional


Correspondence Bank

SendingRouting Char Routing number for ACH Optional


based Transactions of
corresponding bank

SendingSignitory Char Account signitory Optional

SendingCurrency Char Sending Currency

Amount Number Sending Amount

SalesOrder Char Reason information Optional

CustPO Char Reason information Optional

InvoiceNum Char Reason information Optional

Description Char Reason information

TrasferRequestId Char Uniqu identifier of the PK


sending institution.

ReceivingAccount Char Account of the receiver

ReceivingIBAN Char Receiving Account Optional


holder’s IBAN

ReceivingInstitution Char Receiving Bank’s name Optional

ReceivingBIC Char Receiving Bank’s SWIFT Optional

ReceivingRouting Char Receiving Bank’s ACH Optional


Routing number

ReceivingSignitory Char Receiving Signitory’s Optional


name

You might also like