Overview
A configuration is provided for establishing connections with the OFX service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Configuration
The provided configuration handles the authentication aspect of communicating with the service. To invoke endpoints, specific to you integration needs, consider defining custom resources (to be used with REST Source and/or REST Destination) or use the REST Web Service Request Task. If you have suggestions for further improvements, we will be happy to hear your feedback.
Download the configuration from here. Then review the KB article posted here how to use the configuration.
Base URL address: https://sandbox.api.ofx.com/v1.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://payments.developer.ofx.com/authentication/introduction.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/payments/quotes.Documentation: https://payments.developer.ofx.com/specs/quotes/create-quote.
- [Update] action
-
Endpoint URL address:
/payments/quotes/{{=item.id}}.Documentation: https://payments.developer.ofx.com/specs/quotes/update-quote.
- id
A key field. Data type: DT_GUID
- buyCurrency
Template: ShortText.
- buyAmount
Data type: DT_R8
- sellCurrency
Template: ShortText.
- sellAmount
Data type: DT_R8
- customerRate
Data type: DT_R8
- inverseCustomerRate
Data type: DT_R8
- fee
Data type: DT_R8
- feeCurrency
Template: ShortText.
- freebies
Field components:
- Contains the following components: total, claimed, remaining.
- beneficiaries
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payments/beneficiaries.
The result is extracted from:{{=response.beneficiaries}}.Documentation: https://payments.developer.ofx.com/specs/beneficiaries/get-beneficiaries.
- [Create] action
-
Endpoint URL address:
/payments/beneficiaries.Documentation: https://payments.developer.ofx.com/specs/beneficiaries/create-beneficiary.
- [Update] action
-
Endpoint URL address:
/payments/beneficiaries/{{=item.beneficiaryId}}.Documentation: https://payments.developer.ofx.com/specs/beneficiaries/edit-beneficiary.
- [Delete] action
-
Endpoint URL address:
/payments/beneficiaries/{{=item.beneficiaryId}}.Documentation: https://payments.developer.ofx.com/specs/beneficiaries/delete-beneficiary.
- beneficiaryId
A key field. Template: ShortText.
- name
Template: ShortText.
- currency
Template: ShortText.
- alias
Template: ShortText.
Template: ShortText.
- classification
Template: ShortText.
- paymentReason
Template: ShortText.
- beneficiaryBankDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: bankName, bankBranchName, bankCode, branchCode, swift, account, accountSuffix, reference, bankCorrespondent, bankAddress.
-
Uses template:
- beneficiaryAddress
Template: Address.
- benBizNumber
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/payments/deals.
The result is extracted from:{{=response.deals}}.Documentation: https://payments.developer.ofx.com/specs/deals/gets-a-list-of-deals-filtered-by-dealstatus-and-dealtype-and-pagination.
- [Create] action
-
Endpoint URL address:
/payments/deals.Documentation: https://payments.developer.ofx.com/specs/deals/create-a-deal.
- dealId
A key field. Template: ShortText.
- dealType
Template: ShortText.
- buyCurrency
Template: ShortText.
- buyAmount
Data type: DT_R8
- sellCurrency
Template: ShortText.
- sellAmount
Data type: DT_R8
- rate
Data type: DT_R8
- status
Template: ShortText.
- reference
Template: ShortText.
- enteredDate
Template: DateTime.
- maturityDate
Template: DateTime.
- fee
Data type: DT_R8
- feeCurrency
Template: ShortText.
- BPayNumber
Data type: DT_I4
- stateInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: dealState, isSettled, isAwaitingFunds, dealStateDisplay.
-
Uses template:
- dealBeneficiaries
Template: LongText. A composite field.
- quoteId
Template: ShortText.
- fundingSource
Template: ShortText.
- customer
Field components:
-
Uses template:
ShortText. - Contains the following components: title, firstName, middleName, lastName, companyName, branchName, accountNumber, address1, city, state, postCode, countryISOCode.
-
Uses template:
- beneficiaries
The value is gathered from
/payments/deals/{{=item.dealId}}/beneficiariesaddress. The gathered value is processed with{{=response.dealBeneficiaries}}expression. Field components:- An array.
- Contains the following components: beneficiaryId, amount, payReason, payReference.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.Documentation: https://payments.developer.ofx.com/usersspecs/users/get-a-list-of-all-users.
- userId
A key field. Data type: DT_GUID
- hasBeneficiary
Data type: DT_BOOL
- status
Template: ShortText.
- [Read] action
-
The result is extracted from:{{=response}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
pageSize:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Address
Field components:
-
Uses template:
ShortText. - Contains the following components: addressLine, citySuburb, stateProvince, postCode, country.
-
Uses template:
Knowledge Base
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.