Back to Index

POST v1/FundsTransferNotifications

Sets or resets a token to a given date from which to receive notifications

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

funds_transfer_token_request
NameDescriptionTypeAdditional information
from_date_utc

Sets the date associated with the token, from which the Funds Transfers Notifications will be returned

string

Required

application_name

The name of the calling application

string

Required

String length: inclusive between 0 and 128

language_code

Determines the Language of the response data. 2 Character ISO LanguageCode. Supported language codes are: 'en' (English), 'fr' (French). Default is 'en'.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "from_date_utc": "sample string 1",
  "application_name": "sample string 2",
  "language_code": "en"
}

Response Information

Resource Description

funds_transfer_notifications_response
NameDescriptionTypeAdditional information
notifications

List containing the new notifications since the time associated with the token

Collection of state_change_notification

None.

token

The new token to be submitted for the next Funds Transfer Notification Request

string

None.

success

True if successful, false otherwise

boolean

None.

message

The message related to the operation in the language specified by the request

string

None.

message_code

The code associated with the message

integer

None.

errors

List of validation errors that occured, otherwise empty

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "notifications": [
    {
      "amount": 1.0,
      "state_change_to": {
        "name": "sample string 1",
        "code": "sample string 2"
      },
      "reason": "sample string 1",
      "state_change_datetime": "2019-01-23T16:46:32.5380038-08:00",
      "transaction_ref_code": "sample string 3",
      "schedule_token": "sample string 4",
      "references": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ]
    },
    {
      "amount": 1.0,
      "state_change_to": {
        "name": "sample string 1",
        "code": "sample string 2"
      },
      "reason": "sample string 1",
      "state_change_datetime": "2019-01-23T16:46:32.5380038-08:00",
      "transaction_ref_code": "sample string 3",
      "schedule_token": "sample string 4",
      "references": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ]
    }
  ],
  "token": "sample string 1",
  "success": true,
  "message": "sample string 3",
  "message_code": 4,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}