TXAPI v1.0.3.x

TXAPI OpenAPI specification

Authentication

• HTTP Authentication, scheme: basic

Default

GETGet card

GET /tx/v1/card

Retrieves card details by card unique reference. Use the reference parameter to specify the card to return. For security reasons, the PAN is not fully visible on the card object returned (PAN is returned masked).

Parameters

Name	In	Type	Required	Description
ref	query	card-CardRef	✔	Unique reference to the card

Example responses

200 Response

{
  "ref": {
    "id": 13579,
    "rid": "CRDRID24680"
  },
  "className": "Smart cards",
  "holder": {
    "id": 1746,
    "rid": "PRID73"
  },
  "issuingContractType": {
    "id": 97548,
    "rid": "CTRID975"
  },
  "issuingContract": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "financialContract": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "mainCard": {
    "id": 13579,
    "rid": "CRDRID24680"
  },
  "product": {
    "id": 22,
    "rid": "CPRID22"
  },
  "design": {
    "id": 12,
    "rid": "DESRID12"
  },
  "panMask": "777777******6543",
  "mbr": 0,
  "status": "string",
  "lifePhaseRid": "LCRID_ATBRANCH",
  "restrictionsProfile": {
    "id": 6846,
    "rid": "RPRID78"
  },
  "tdsEnrollment": true,
  "logistics": {
    "deliveryBranchName": "Branch 1",
    "deliveryAddress": {
      "zip": "NG71AE",
      "country": 0,
      "region": "CAL",
      "regionRid": "string",
      "area": "Nord",
      "areaRid": "string",
      "city": "Homeburg",
      "cityRid": "string",
      "street": "Broadway",
      "streetRid": "string",
      "house": 15,
      "building": 2,
      "construction": 1,
      "flat": 4,
      "addressInCity": null,
      "addressInCountry": null,
      "recipientName": "Robert Smith",
      "phone": 976356838473,
      "fax": null,
      "mobile": 976356838473,
      "email": "r.smith@mymail.net",
      "url": null
    },
    "curBranchName": "Central office"
  },
  "names": {
    "emboss": "Smith",
    "track": "Smith",
    "print": "Smith"
  },
  "dates": {
    "validFrom": "2019-08-24",
    "creation": "2019-08-24",
    "activation": "2019-08-24",
    "expiration": "2019-08-24",
    "closure": "2019-08-24"
  },
  "notes": "Test card",
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	card
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

PUTCreate or update card

PUT /tx/v1/card

Creates new or updates an existing card

Request body

{
  "object": {
    "ref": {
      "id": 13579,
      "rid": "CRDRID24680"
    },
    "className": "Smart cards",
    "holder": {
      "id": 1746,
      "rid": "PRID73"
    },
    "issuingContractType": {
      "id": 97548,
      "rid": "CTRID975"
    },
    "issuingContract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    },
    "financialContract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    },
    "mainCard": {
      "id": 13579,
      "rid": "CRDRID24680"
    },
    "product": {
      "id": 22,
      "rid": "CPRID22"
    },
    "design": {
      "id": 12,
      "rid": "DESRID12"
    },
    "panMask": "777777******6543",
    "mbr": 0,
    "status": "string",
    "lifePhaseRid": "LCRID_ATBRANCH",
    "restrictionsProfile": {
      "id": 6846,
      "rid": "RPRID78"
    },
    "tdsEnrollment": true,
    "logistics": {
      "deliveryBranchName": "Branch 1",
      "deliveryAddress": {
        "zip": "NG71AE",
        "country": 0,
        "region": "CAL",
        "regionRid": "string",
        "area": "Nord",
        "areaRid": "string",
        "city": "Homeburg",
        "cityRid": "string",
        "street": "Broadway",
        "streetRid": "string",
        "house": 15,
        "building": 2,
        "construction": 1,
        "flat": 4,
        "addressInCity": null,
        "addressInCountry": null,
        "recipientName": "Robert Smith",
        "phone": 976356838473,
        "fax": null,
        "mobile": 976356838473,
        "email": "r.smith@mymail.net",
        "url": null
      },
      "curBranchName": "Central office"
    },
    "names": {
      "emboss": "Smith",
      "track": "Smith",
      "print": "Smith"
    },
    "dates": {
      "validFrom": "2019-08-24",
      "creation": "2019-08-24",
      "activation": "2019-08-24",
      "expiration": "2019-08-24",
      "closure": "2019-08-24"
    },
    "notes": "Test card",
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
mustExist	query	boolean		Object presence control. Refer to Idempotency chapter to get more details on parameter usage.
body	body	object	✔
└─ object	body	card	✔	Card object
‎‎ ‎ └─ ref	body	card-CardRef		References to the card
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Card internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Card reference ID
‎‎ ‎ └─ className	body	string		General type of the card used for card production, e.g. "Visa Smart Debit/Credit", "MChip Advance", "JCB J/Smart", etc. These classes are predefined in the system and applied during the card product setup in TX. Refer to the TX documentation for a complete list of classes supported.
‎‎ ‎ └─ holder	body	subject-SubjectRef		References to the person/company
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ └─ issuingContractType	body	contract-type-ContractTypeRef		References to the contract type
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Contract type ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Contract type reference ID
‎‎ ‎ └─ issuingContract	body	contract-ContractRef		References to the contract
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ ‎‎ ‎ └─ extRid	body	string		Contract external reference ID
‎‎ ‎ └─ financialContract	body	contract-ContractRef		References to the contract
‎‎ ‎ └─ mainCard	body	card-CardRef		References to the card
‎‎ ‎ └─ product	body	card-product-CardProductRef		Reference to card product
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Card product ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Card product reference ID
‎‎ ‎ └─ design	body	card-design-CardDesignRef		Reference to card design
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Card design internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Card design reference ID
‎‎ ‎ └─ panMask	body	string		Masked PAN
‎‎ ‎ └─ mbr	body	integer		Card member number / EMV application PAN sequence number
‎‎ ‎ └─ status	body	string		Card status
‎‎ ‎ └─ lifePhaseRid	body	string		Card lifecycle phase reference ID. Card lifecycle phases are configured in the system, refer to the TX setup to obtain the list of lifecycle phase IDs configured.
‎‎ ‎ └─ restrictionsProfile	body	restriction-RestrictionProfileRef		References to the restriction profile
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Restriction profile internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Restriction profile reference ID
‎‎ ‎ └─ tdsEnrollment	body	boolean		Indicates if the card is enrolled to e-commerce 3DS service
‎‎ ‎ └─ logistics	body	object		Card delivery details
‎‎ ‎ ‎‎ ‎ └─ deliveryBranchName	body	string		The branch name where card will be delivered to, in case if the card should be delivered to the branch
‎‎ ‎ ‎‎ ‎ └─ deliveryAddress	body	common-Address		Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ zip	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ country	body	integer		ISO numeric code
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ region	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ regionRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ area	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ areaRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ city	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cityRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ street	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ streetRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ house	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ building	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ construction	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ flat	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCity	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCountry	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ recipientName	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ phone	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ fax	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mobile	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ email	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ url	body	string
‎‎ ‎ ‎‎ ‎ └─ curBranchName	body	string		The branch name where the card currently is
‎‎ ‎ └─ names	body	object		Names on the card
‎‎ ‎ ‎‎ ‎ └─ emboss	body	string		Name to be printed/embossed on the card
‎‎ ‎ ‎‎ ‎ └─ track	body	string		Name to be written on the Track2 or chip
‎‎ ‎ ‎‎ ‎ └─ print	body	string		Name to be printed on other media, e.g. PIN mailer, etc.
‎‎ ‎ └─ dates	body	object
‎‎ ‎ ‎‎ ‎ └─ validFrom	body	string(date)		The date the card is valid from
‎‎ ‎ ‎‎ ‎ └─ creation	body	string(date)		Card creation date
‎‎ ‎ ‎‎ ‎ └─ activation	body	string(date)		Card activation date
‎‎ ‎ ‎‎ ‎ └─ expiration	body	string(date)	✔	Card expiration date. This is the full date value, please convert to short format as required, e.g. usually the card expiration date is presented to customers as MM/YY.
‎‎ ‎ ‎‎ ‎ └─ closure	body	string(date)		Card closure date
‎‎ ‎ └─ notes	body	string		Notes attached to the card
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-ModifyTranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

DELETEDelete card

DELETE /tx/v1/card

Deletes an existing card

Parameters

Name	In	Type	Required	Description
ref	query	card-CardRef	✔	Unique reference to the card

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

GETShow card PAN

GET /tx/v1/card/pan

Gets a full PAN of the card. This endpoint can be used if the full PAN is required, e.g. to be displayed to a cardholder in a mobile app, as for security reasons, the PAN is not fully visible on the card object returned by GET /card operation. This endpoint may require PCI DSS compliance. You must comply with PCI DSS data security requirements if you store, transmit, or process sensitive card data such as the cardholder's primary account number (PAN), personal identification number (PIN), and card expiration date.

Parameters

Name	In	Type	Required	Description
ref	query	card-CardRef	✔	Unique reference to the card

Example responses

200 Response

{
  "pan": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ pan	string			PAN value

GETShow card CVV2

GET /tx/v1/card/cvv2

Gets a CVV2 of the card. This endpoint can be used if the CVV2 is required, e.g. to be displayed to a cardholder in a mobile app, as for security reasons, the CVV2 is not visible on the card object returned by GET /card operation. This endpoint may require PCI DSS compliance. You must comply with PCI DSS data security requirements if you store, transmit, or process sensitive card data such as the cardholder's primary account number (PAN), personal identification number (PIN), and card expiration date.

Parameters

Name	In	Type	Required	Description
ref	query	card-CardRef	✔	Unique reference to the card

Example responses

200 Response

{
  "cvv2": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ cvv2	string			Card CVV2 value

POSTGet card by PAN

POST /tx/v1/card/pan/list

Lists cards by PAN, and optionally by expiration date. This request is useful e.g. in IVR scenarios where a user has telephoned and identifies the card by the PAN. The retrieval of the data is implemented as a POST request because supplying the PAN in the request body is more secure than supplying it in the URL (as would be required with a GET).

Request body

{
  "pan": "string",
  "expiration": "2019-08-24"
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ pan	body	string	✔	Card PAN
└─ expiration	body	string(date)		Card expiration date

Example responses

200 Response

{
  "objects": [
    {
      "ref": {
        "id": 13579,
        "rid": "CRDRID24680"
      },
      "className": "Smart cards",
      "holder": {
        "id": 1746,
        "rid": "PRID73"
      },
      "issuingContractType": {
        "id": 97548,
        "rid": "CTRID975"
      },
      "issuingContract": {
        "id": 4680,
        "rid": "CRID4542809",
        "extRid": "CASA1268"
      },
      "financialContract": {
        "id": 4680,
        "rid": "CRID4542809",
        "extRid": "CASA1268"
      },
      "mainCard": {
        "id": 13579,
        "rid": "CRDRID24680"
      },
      "product": {
        "id": 22,
        "rid": "CPRID22"
      },
      "design": {
        "id": 12,
        "rid": "DESRID12"
      },
      "panMask": "777777******6543",
      "mbr": 0,
      "status": "string",
      "lifePhaseRid": "LCRID_ATBRANCH",
      "restrictionsProfile": {
        "id": 6846,
        "rid": "RPRID78"
      },
      "tdsEnrollment": true,
      "logistics": {
        "deliveryBranchName": "Branch 1",
        "deliveryAddress": {
          "zip": "NG71AE",
          "country": 0,
          "region": "CAL",
          "regionRid": "string",
          "area": "Nord",
          "areaRid": "string",
          "city": "Homeburg",
          "cityRid": "string",
          "street": "Broadway",
          "streetRid": "string",
          "house": 15,
          "building": 2,
          "construction": 1,
          "flat": 4,
          "addressInCity": null,
          "addressInCountry": null,
          "recipientName": "Robert Smith",
          "phone": 976356838473,
          "fax": null,
          "mobile": 976356838473,
          "email": "r.smith@mymail.net",
          "url": null
        },
        "curBranchName": "Central office"
      },
      "names": {
        "emboss": "Smith",
        "track": "Smith",
        "print": "Smith"
      },
      "dates": {
        "validFrom": "2019-08-24",
        "creation": "2019-08-24",
        "activation": "2019-08-24",
        "expiration": "2019-08-24",
        "closure": "2019-08-24"
      },
      "notes": "Test card",
      "userAttrs": [
        {
          "rid": "UDPRID3",
          "val": "VAL-1"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ objects	[card]			Contains the returned cards
‎‎ ‎ └─ Card object	card			Card object
‎‎ ‎ ‎‎ ‎ └─ ref	card-CardRef			References to the card
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Card internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Card reference ID
‎‎ ‎ ‎‎ ‎ └─ className	string			General type of the card used for card production, e.g. "Visa Smart Debit/Credit", "MChip Advance", "JCB J/Smart", etc. These classes are predefined in the system and applied during the card product setup in TX. Refer to the TX documentation for a complete list of classes supported.
‎‎ ‎ ‎‎ ‎ └─ holder	subject-SubjectRef			References to the person/company
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ ‎‎ ‎ └─ issuingContractType	contract-type-ContractTypeRef			References to the contract type
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Contract type ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Contract type reference ID
‎‎ ‎ ‎‎ ‎ └─ issuingContract	contract-ContractRef			References to the contract
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Contract internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Contract reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ extRid	string			Contract external reference ID
‎‎ ‎ ‎‎ ‎ └─ financialContract	contract-ContractRef			References to the contract
‎‎ ‎ ‎‎ ‎ └─ mainCard	card-CardRef			References to the card
‎‎ ‎ ‎‎ ‎ └─ product	card-product-CardProductRef			Reference to card product
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Card product ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Card product reference ID
‎‎ ‎ ‎‎ ‎ └─ design	card-design-CardDesignRef			Reference to card design
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Card design internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Card design reference ID
‎‎ ‎ ‎‎ ‎ └─ panMask	string			Masked PAN
‎‎ ‎ ‎‎ ‎ └─ mbr	integer			Card member number / EMV application PAN sequence number
‎‎ ‎ ‎‎ ‎ └─ status	string			Card status
‎‎ ‎ ‎‎ ‎ └─ lifePhaseRid	string			Card lifecycle phase reference ID. Card lifecycle phases are configured in the system, refer to the TX setup to obtain the list of lifecycle phase IDs configured.
‎‎ ‎ ‎‎ ‎ └─ restrictionsProfile	restriction-RestrictionProfileRef			References to the restriction profile
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Restriction profile internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Restriction profile reference ID
‎‎ ‎ ‎‎ ‎ └─ tdsEnrollment	boolean			Indicates if the card is enrolled to e-commerce 3DS service
‎‎ ‎ ‎‎ ‎ └─ logistics	object			Card delivery details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ deliveryBranchName	string			The branch name where card will be delivered to, in case if the card should be delivered to the branch
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ deliveryAddress	common-Address			Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ zip	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ country	integer			ISO numeric code
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ region	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ regionRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ area	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ areaRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ city	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cityRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ street	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ streetRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ house	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ building	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ construction	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ flat	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCity	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCountry	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ recipientName	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ phone	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ fax	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mobile	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ email	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ url	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ curBranchName	string			The branch name where the card currently is
‎‎ ‎ ‎‎ ‎ └─ names	object			Names on the card
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ emboss	string			Name to be printed/embossed on the card
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ track	string			Name to be written on the Track2 or chip
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ print	string			Name to be printed on other media, e.g. PIN mailer, etc.
‎‎ ‎ ‎‎ ‎ └─ dates	object
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ validFrom	string(date)			The date the card is valid from
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ creation	string(date)			Card creation date
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ activation	string(date)			Card activation date
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ expiration	string(date)	✔		Card expiration date. This is the full date value, please convert to short format as required, e.g. usually the card expiration date is presented to customers as MM/YY.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ closure	string(date)			Card closure date
‎‎ ‎ ‎‎ ‎ └─ notes	string			Notes attached to the card
‎‎ ‎ ‎‎ ‎ └─ userAttrs	[common-UserAttr]			Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ val	string			Value

GETGet card PIN

GET /tx/v1/card/pin

Gets PIN block value of the card. (!) Only use this endpoint to access a PIN in order to reveal it to its cardholder. Do not use this endpoint for the purpose of storing a PIN at any location. This endpoint may require PCI DSS compliance. You must comply with PCI DSS data security requirements if you store, transmit, or process sensitive card data such as the cardholder's primary account number (PAN), personal identification number (PIN), and card expiration date.

Parameters

Name	In	Type	Required	Description
ref	query	card-CardRef	✔	Unique reference to the card

Example responses

200 Response

{
  "pinBlock": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ pinBlock	string(base64)			Card encrypted PIN block. PIN block format and encryption parameters are defined in the respective RTP interface configuration in TX.

PUTSet card PIN

PUT /tx/v1/card/pin

Sets PIN block for the card. This endpoint can be used to create or update PIN for a card. Sending a request to this endpoint may require PCI DSS compliance. You must comply with PCI DSS data security requirements if you want to store, transmit, or process sensitive card data such as the cardholder's primary account number (PAN), personal identification number (PIN), and card expiration date.

Request body

{
  "pinBlock": "string",
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
ref	query	card-CardRef	✔	Unique reference to the card
body	body	object	✔
└─ pinBlock	body	string(base64)	✔	Card encrypted PIN block. PIN block format and encryption parameters are defined in the respective RTP interface configuration in TX.
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

DELETEReset card counters (e.g. unblock PIN)

DELETE /tx/v1/card/try-counters

This endpoint can be used to reset the security counters of a card, such as PIN tries, CVV2 tries, etc.

Parameters

Name	In	Type	Required	Description
ref	query	card-CardRef	✔	Unique reference to the card
countersToReset	query	CountersToReset		Counters to reset (if not set then reset all)

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTCard reissuance (replace, renewal)

POST /tx/v1/card/reissue

Use this endpoint to create a new card during the reissuance of the existing card e.g. if the card is lost, stolen or damaged or renewal (e.g. if the card is expired).

Request body

{
  "copyFromOldCard": {
    "pan": true,
    "pin": true,
    "limits": true,
    "rid": true
  },
  "newCard": {
    "ref": {
      "id": 13579,
      "rid": "CRDRID24680"
    },
    "className": "Smart cards",
    "holder": {
      "id": 1746,
      "rid": "PRID73"
    },
    "issuingContractType": {
      "id": 97548,
      "rid": "CTRID975"
    },
    "issuingContract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    },
    "financialContract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    },
    "mainCard": {
      "id": 13579,
      "rid": "CRDRID24680"
    },
    "product": {
      "id": 22,
      "rid": "CPRID22"
    },
    "design": {
      "id": 12,
      "rid": "DESRID12"
    },
    "panMask": "777777******6543",
    "mbr": 0,
    "status": "string",
    "lifePhaseRid": "LCRID_ATBRANCH",
    "restrictionsProfile": {
      "id": 6846,
      "rid": "RPRID78"
    },
    "tdsEnrollment": true,
    "logistics": {
      "deliveryBranchName": "Branch 1",
      "deliveryAddress": {
        "zip": "NG71AE",
        "country": 0,
        "region": "CAL",
        "regionRid": "string",
        "area": "Nord",
        "areaRid": "string",
        "city": "Homeburg",
        "cityRid": "string",
        "street": "Broadway",
        "streetRid": "string",
        "house": 15,
        "building": 2,
        "construction": 1,
        "flat": 4,
        "addressInCity": null,
        "addressInCountry": null,
        "recipientName": "Robert Smith",
        "phone": 976356838473,
        "fax": null,
        "mobile": 976356838473,
        "email": "r.smith@mymail.net",
        "url": null
      },
      "curBranchName": "Central office"
    },
    "names": {
      "emboss": "Smith",
      "track": "Smith",
      "print": "Smith"
    },
    "dates": {
      "validFrom": "2019-08-24",
      "creation": "2019-08-24",
      "activation": "2019-08-24",
      "expiration": "2019-08-24",
      "closure": "2019-08-24"
    },
    "notes": "Test card",
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
ref	query	card-CardRef	✔	Unique reference to the card
body	body	object	✔
└─ copyFromOldCard	body	object		Parameters to control the properties to copy from the card that is being reissued
‎‎ ‎ └─ pan	body	boolean		Keep card PAN. A value of false indicates that the system will generate new PAN for the card. For security reasons, the old PAN should not be copied if the card is replaced due to such reasons as lost, stolen, etc.
‎‎ ‎ └─ pin	body	boolean		Keep card PIN
‎‎ ‎ └─ limits	body	boolean		Keep card limits and restrictions
‎‎ ‎ └─ rid	body	boolean		Keep card reference ID
└─ newCard	body	card		Card object
‎‎ ‎ └─ ref	body	card-CardRef		References to the card
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Card internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Card reference ID
‎‎ ‎ └─ className	body	string		General type of the card used for card production, e.g. "Visa Smart Debit/Credit", "MChip Advance", "JCB J/Smart", etc. These classes are predefined in the system and applied during the card product setup in TX. Refer to the TX documentation for a complete list of classes supported.
‎‎ ‎ └─ holder	body	subject-SubjectRef		References to the person/company
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ └─ issuingContractType	body	contract-type-ContractTypeRef		References to the contract type
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Contract type ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Contract type reference ID
‎‎ ‎ └─ issuingContract	body	contract-ContractRef		References to the contract
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ ‎‎ ‎ └─ extRid	body	string		Contract external reference ID
‎‎ ‎ └─ financialContract	body	contract-ContractRef		References to the contract
‎‎ ‎ └─ mainCard	body	card-CardRef		References to the card
‎‎ ‎ └─ product	body	card-product-CardProductRef		Reference to card product
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Card product ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Card product reference ID
‎‎ ‎ └─ design	body	card-design-CardDesignRef		Reference to card design
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Card design internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Card design reference ID
‎‎ ‎ └─ panMask	body	string		Masked PAN
‎‎ ‎ └─ mbr	body	integer		Card member number / EMV application PAN sequence number
‎‎ ‎ └─ status	body	string		Card status
‎‎ ‎ └─ lifePhaseRid	body	string		Card lifecycle phase reference ID. Card lifecycle phases are configured in the system, refer to the TX setup to obtain the list of lifecycle phase IDs configured.
‎‎ ‎ └─ restrictionsProfile	body	restriction-RestrictionProfileRef		References to the restriction profile
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Restriction profile internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Restriction profile reference ID
‎‎ ‎ └─ tdsEnrollment	body	boolean		Indicates if the card is enrolled to e-commerce 3DS service
‎‎ ‎ └─ logistics	body	object		Card delivery details
‎‎ ‎ ‎‎ ‎ └─ deliveryBranchName	body	string		The branch name where card will be delivered to, in case if the card should be delivered to the branch
‎‎ ‎ ‎‎ ‎ └─ deliveryAddress	body	common-Address		Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ zip	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ country	body	integer		ISO numeric code
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ region	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ regionRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ area	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ areaRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ city	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cityRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ street	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ streetRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ house	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ building	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ construction	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ flat	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCity	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCountry	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ recipientName	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ phone	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ fax	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mobile	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ email	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ url	body	string
‎‎ ‎ ‎‎ ‎ └─ curBranchName	body	string		The branch name where the card currently is
‎‎ ‎ └─ names	body	object		Names on the card
‎‎ ‎ ‎‎ ‎ └─ emboss	body	string		Name to be printed/embossed on the card
‎‎ ‎ ‎‎ ‎ └─ track	body	string		Name to be written on the Track2 or chip
‎‎ ‎ ‎‎ ‎ └─ print	body	string		Name to be printed on other media, e.g. PIN mailer, etc.
‎‎ ‎ └─ dates	body	object
‎‎ ‎ ‎‎ ‎ └─ validFrom	body	string(date)		The date the card is valid from
‎‎ ‎ ‎‎ ‎ └─ creation	body	string(date)		Card creation date
‎‎ ‎ ‎‎ ‎ └─ activation	body	string(date)		Card activation date
‎‎ ‎ ‎‎ ‎ └─ expiration	body	string(date)	✔	Card expiration date. This is the full date value, please convert to short format as required, e.g. usually the card expiration date is presented to customers as MM/YY.
‎‎ ‎ ‎‎ ‎ └─ closure	body	string(date)		Card closure date
‎‎ ‎ └─ notes	body	string		Notes attached to the card
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-ModifyTranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTAssign prepaid/pre-printed card to a customer

POST /tx/v1/card/preproduced/deliver

Selects a pre-printed card from the batch of cards, assigns it to a customer and sets the card parameters , e.g. status, life cycle phase, etc. Usually such pre-printed cards are not personalized (unnamed) and have limited usage.

Request body

{
  "pan": "string",
  "card": {
    "ref": {
      "id": 13579,
      "rid": "CRDRID24680"
    },
    "className": "Smart cards",
    "holder": {
      "id": 1746,
      "rid": "PRID73"
    },
    "issuingContractType": {
      "id": 97548,
      "rid": "CTRID975"
    },
    "issuingContract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    },
    "financialContract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    },
    "mainCard": {
      "id": 13579,
      "rid": "CRDRID24680"
    },
    "product": {
      "id": 22,
      "rid": "CPRID22"
    },
    "design": {
      "id": 12,
      "rid": "DESRID12"
    },
    "panMask": "777777******6543",
    "mbr": 0,
    "status": "string",
    "lifePhaseRid": "LCRID_ATBRANCH",
    "restrictionsProfile": {
      "id": 6846,
      "rid": "RPRID78"
    },
    "tdsEnrollment": true,
    "logistics": {
      "deliveryBranchName": "Branch 1",
      "deliveryAddress": {
        "zip": "NG71AE",
        "country": 0,
        "region": "CAL",
        "regionRid": "string",
        "area": "Nord",
        "areaRid": "string",
        "city": "Homeburg",
        "cityRid": "string",
        "street": "Broadway",
        "streetRid": "string",
        "house": 15,
        "building": 2,
        "construction": 1,
        "flat": 4,
        "addressInCity": null,
        "addressInCountry": null,
        "recipientName": "Robert Smith",
        "phone": 976356838473,
        "fax": null,
        "mobile": 976356838473,
        "email": "r.smith@mymail.net",
        "url": null
      },
      "curBranchName": "Central office"
    },
    "names": {
      "emboss": "Smith",
      "track": "Smith",
      "print": "Smith"
    },
    "dates": {
      "validFrom": "2019-08-24",
      "creation": "2019-08-24",
      "activation": "2019-08-24",
      "expiration": "2019-08-24",
      "closure": "2019-08-24"
    },
    "notes": "Test card",
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ pan	body	string	✔	The system will try to find the card by PAN and card/dates/expiration
└─ card	body	card		Card object
‎‎ ‎ └─ ref	body	card-CardRef		References to the card
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Card internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Card reference ID
‎‎ ‎ └─ className	body	string		General type of the card used for card production, e.g. "Visa Smart Debit/Credit", "MChip Advance", "JCB J/Smart", etc. These classes are predefined in the system and applied during the card product setup in TX. Refer to the TX documentation for a complete list of classes supported.
‎‎ ‎ └─ holder	body	subject-SubjectRef		References to the person/company
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ └─ issuingContractType	body	contract-type-ContractTypeRef		References to the contract type
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Contract type ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Contract type reference ID
‎‎ ‎ └─ issuingContract	body	contract-ContractRef		References to the contract
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ ‎‎ ‎ └─ extRid	body	string		Contract external reference ID
‎‎ ‎ └─ financialContract	body	contract-ContractRef		References to the contract
‎‎ ‎ └─ mainCard	body	card-CardRef		References to the card
‎‎ ‎ └─ product	body	card-product-CardProductRef		Reference to card product
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Card product ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Card product reference ID
‎‎ ‎ └─ design	body	card-design-CardDesignRef		Reference to card design
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Card design internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Card design reference ID
‎‎ ‎ └─ panMask	body	string		Masked PAN
‎‎ ‎ └─ mbr	body	integer		Card member number / EMV application PAN sequence number
‎‎ ‎ └─ status	body	string		Card status
‎‎ ‎ └─ lifePhaseRid	body	string		Card lifecycle phase reference ID. Card lifecycle phases are configured in the system, refer to the TX setup to obtain the list of lifecycle phase IDs configured.
‎‎ ‎ └─ restrictionsProfile	body	restriction-RestrictionProfileRef		References to the restriction profile
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Restriction profile internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Restriction profile reference ID
‎‎ ‎ └─ tdsEnrollment	body	boolean		Indicates if the card is enrolled to e-commerce 3DS service
‎‎ ‎ └─ logistics	body	object		Card delivery details
‎‎ ‎ ‎‎ ‎ └─ deliveryBranchName	body	string		The branch name where card will be delivered to, in case if the card should be delivered to the branch
‎‎ ‎ ‎‎ ‎ └─ deliveryAddress	body	common-Address		Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ zip	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ country	body	integer		ISO numeric code
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ region	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ regionRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ area	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ areaRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ city	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cityRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ street	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ streetRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ house	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ building	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ construction	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ flat	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCity	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCountry	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ recipientName	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ phone	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ fax	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mobile	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ email	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ url	body	string
‎‎ ‎ ‎‎ ‎ └─ curBranchName	body	string		The branch name where the card currently is
‎‎ ‎ └─ names	body	object		Names on the card
‎‎ ‎ ‎‎ ‎ └─ emboss	body	string		Name to be printed/embossed on the card
‎‎ ‎ ‎‎ ‎ └─ track	body	string		Name to be written on the Track2 or chip
‎‎ ‎ ‎‎ ‎ └─ print	body	string		Name to be printed on other media, e.g. PIN mailer, etc.
‎‎ ‎ └─ dates	body	object
‎‎ ‎ ‎‎ ‎ └─ validFrom	body	string(date)		The date the card is valid from
‎‎ ‎ ‎‎ ‎ └─ creation	body	string(date)		Card creation date
‎‎ ‎ ‎‎ ‎ └─ activation	body	string(date)		Card activation date
‎‎ ‎ ‎‎ ‎ └─ expiration	body	string(date)	✔	Card expiration date. This is the full date value, please convert to short format as required, e.g. usually the card expiration date is presented to customers as MM/YY.
‎‎ ‎ ‎‎ ‎ └─ closure	body	string(date)		Card closure date
‎‎ ‎ └─ notes	body	string		Notes attached to the card
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-ModifyTranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

GETList customer cards

GET /tx/v1/cards

Gets the list of cards for a customer. This endpoint supports filtering, sorting and pagination.

Parameters

Name	In	Type	Required	Description
filter	query	CardsFilter		Filtering criteria. Refer to Filtering chapter to get more details on parameter usage.
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.
order	query	CardsOrder		Sorting parameters. Refer to Sorting chapter to get more details on parameter usage.

order ─ Enumerated Value

Value
IdAsc
IdDesc

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": 13579,
        "rid": "CRDRID24680"
      },
      "className": "Smart cards",
      "holder": {
        "id": 1746,
        "rid": "PRID73"
      },
      "issuingContractType": {
        "id": 97548,
        "rid": "CTRID975"
      },
      "issuingContract": {
        "id": 4680,
        "rid": "CRID4542809",
        "extRid": "CASA1268"
      },
      "financialContract": {
        "id": 4680,
        "rid": "CRID4542809",
        "extRid": "CASA1268"
      },
      "mainCard": {
        "id": 13579,
        "rid": "CRDRID24680"
      },
      "product": {
        "id": 22,
        "rid": "CPRID22"
      },
      "design": {
        "id": 12,
        "rid": "DESRID12"
      },
      "panMask": "777777******6543",
      "mbr": 0,
      "status": "string",
      "lifePhaseRid": "LCRID_ATBRANCH",
      "restrictionsProfile": {
        "id": 6846,
        "rid": "RPRID78"
      },
      "tdsEnrollment": true,
      "logistics": {
        "deliveryBranchName": "Branch 1",
        "deliveryAddress": {
          "zip": "NG71AE",
          "country": 0,
          "region": "CAL",
          "regionRid": "string",
          "area": "Nord",
          "areaRid": "string",
          "city": "Homeburg",
          "cityRid": "string",
          "street": "Broadway",
          "streetRid": "string",
          "house": 15,
          "building": 2,
          "construction": 1,
          "flat": 4,
          "addressInCity": null,
          "addressInCountry": null,
          "recipientName": "Robert Smith",
          "phone": 976356838473,
          "fax": null,
          "mobile": 976356838473,
          "email": "r.smith@mymail.net",
          "url": null
        },
        "curBranchName": "Central office"
      },
      "names": {
        "emboss": "Smith",
        "track": "Smith",
        "print": "Smith"
      },
      "dates": {
        "validFrom": "2019-08-24",
        "creation": "2019-08-24",
        "activation": "2019-08-24",
        "expiration": "2019-08-24",
        "closure": "2019-08-24"
      },
      "notes": "Test card",
      "userAttrs": [
        {
          "rid": "UDPRID3",
          "val": "VAL-1"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[card]			Contains the returned cards
‎‎ ‎ └─ Card object	card			Card object
‎‎ ‎ ‎‎ ‎ └─ ref	card-CardRef			References to the card
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Card internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Card reference ID
‎‎ ‎ ‎‎ ‎ └─ className	string			General type of the card used for card production, e.g. "Visa Smart Debit/Credit", "MChip Advance", "JCB J/Smart", etc. These classes are predefined in the system and applied during the card product setup in TX. Refer to the TX documentation for a complete list of classes supported.
‎‎ ‎ ‎‎ ‎ └─ holder	subject-SubjectRef			References to the person/company
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ ‎‎ ‎ └─ issuingContractType	contract-type-ContractTypeRef			References to the contract type
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Contract type ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Contract type reference ID
‎‎ ‎ ‎‎ ‎ └─ issuingContract	contract-ContractRef			References to the contract
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Contract internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Contract reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ extRid	string			Contract external reference ID
‎‎ ‎ ‎‎ ‎ └─ financialContract	contract-ContractRef			References to the contract
‎‎ ‎ ‎‎ ‎ └─ mainCard	card-CardRef			References to the card
‎‎ ‎ ‎‎ ‎ └─ product	card-product-CardProductRef			Reference to card product
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Card product ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Card product reference ID
‎‎ ‎ ‎‎ ‎ └─ design	card-design-CardDesignRef			Reference to card design
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Card design internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Card design reference ID
‎‎ ‎ ‎‎ ‎ └─ panMask	string			Masked PAN
‎‎ ‎ ‎‎ ‎ └─ mbr	integer			Card member number / EMV application PAN sequence number
‎‎ ‎ ‎‎ ‎ └─ status	string			Card status
‎‎ ‎ ‎‎ ‎ └─ lifePhaseRid	string			Card lifecycle phase reference ID. Card lifecycle phases are configured in the system, refer to the TX setup to obtain the list of lifecycle phase IDs configured.
‎‎ ‎ ‎‎ ‎ └─ restrictionsProfile	restriction-RestrictionProfileRef			References to the restriction profile
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Restriction profile internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Restriction profile reference ID
‎‎ ‎ ‎‎ ‎ └─ tdsEnrollment	boolean			Indicates if the card is enrolled to e-commerce 3DS service
‎‎ ‎ ‎‎ ‎ └─ logistics	object			Card delivery details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ deliveryBranchName	string			The branch name where card will be delivered to, in case if the card should be delivered to the branch
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ deliveryAddress	common-Address			Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ zip	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ country	integer			ISO numeric code
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ region	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ regionRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ area	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ areaRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ city	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cityRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ street	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ streetRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ house	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ building	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ construction	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ flat	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCity	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCountry	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ recipientName	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ phone	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ fax	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mobile	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ email	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ url	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ curBranchName	string			The branch name where the card currently is
‎‎ ‎ ‎‎ ‎ └─ names	object			Names on the card
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ emboss	string			Name to be printed/embossed on the card
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ track	string			Name to be written on the Track2 or chip
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ print	string			Name to be printed on other media, e.g. PIN mailer, etc.
‎‎ ‎ ‎‎ ‎ └─ dates	object
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ validFrom	string(date)			The date the card is valid from
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ creation	string(date)			Card creation date
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ activation	string(date)			Card activation date
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ expiration	string(date)	✔		Card expiration date. This is the full date value, please convert to short format as required, e.g. usually the card expiration date is presented to customers as MM/YY.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ closure	string(date)			Card closure date
‎‎ ‎ ‎‎ ‎ └─ notes	string			Notes attached to the card
‎‎ ‎ ‎‎ ‎ └─ userAttrs	[common-UserAttr]			Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ val	string			Value

GETList card designs

GET /tx/v1/card-designs

Lists card designs available in the system. This endpoint supports pagination.

Parameters

Name	In	Type	Required	Description
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": 12,
        "rid": "DESRID12"
      },
      "name": "Plain"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[card-design]			Contains the returned card designs
‎‎ ‎ └─ ref	card-design-CardDesignRef			Reference to card design
‎‎ ‎ ‎‎ ‎ └─ id	integer			Card design internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Card design reference ID
‎‎ ‎ └─ name	string			Card design name in TX

GETList card products

GET /tx/v1/card-products

Lists card products available in the system. This endpoint supports pagination.

Parameters

Name	In	Type	Required	Description
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": 22,
        "rid": "CPRID22"
      },
      "name": "Unlimited silver",
      "cardClassName": "Smart cards",
      "parentProduct": {
        "id": 22,
        "rid": "CPRID22"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[card-product]			Contains the returned card products
‎‎ ‎ └─ ref	card-product-CardProductRef			Reference to card product
‎‎ ‎ ‎‎ ‎ └─ id	integer			Card product ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Card product reference ID
‎‎ ‎ └─ name	string			Card product name in TX
‎‎ ‎ └─ cardClassName	string			Name of the card class. Card class in TX defines the general card type used for card production, e.g. "Visa Smart Debit/Credit", "MChip Advance", "JCB J/Smart", etc. These classes are predefined in the system and applied during the card product setup in TX. Refer to the TX documentation for a complete list of classes supported.
‎‎ ‎ └─ parentProduct	card-product-CardProductRef			Reference to card product

GETPerform connectivity test (ping)

GET /

Performs connectivity test to check the service availability

Responses

Status	Meaning	Description	Schema
200	OK	OK

GETGet contract

GET /tx/v1/contract

Retrieves contract details by its reference. For financial contracts, this endpoint can be used to retrieve details of customer's account.

Parameters

Name	In	Type	Required	Description
ref	query	contract-ContractRef	✔	Reference to the contract

Example responses

200 Response

{
  "ref": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "className": "Contract.Shadow",
  "type": {
    "id": 97548,
    "rid": "CTRID975"
  },
  "client": {
    "id": 1746,
    "rid": "PRID73"
  },
  "details": {},
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	contract
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

PUTCreate or update contract

PUT /tx/v1/contract

Creates new or updates an existing contract. For financial contracts, this endpoint can be used to open/update financial account for a customer.

Request body

{
  "object": {
    "ref": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    },
    "className": "Contract.Shadow",
    "type": {
      "id": 97548,
      "rid": "CTRID975"
    },
    "client": {
      "id": 1746,
      "rid": "PRID73"
    },
    "details": {},
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
mustExist	query	boolean		Object presence control. Refer to Idempotency chapter to get more details on parameter usage.
body	body	object
└─ object	body	contract		Contract object. Contract in TX represents a product common conditions and used by the system to power different services, such as card production ("issuing contract"), operations processing ("financial contract"), customer notifications, etc.
‎‎ ‎ └─ ref	body	contract-ContractRef		References to the contract
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ ‎‎ ‎ └─ extRid	body	string		Contract external reference ID
‎‎ ‎ └─ className	body	string		Contract class
‎‎ ‎ └─ type	body	contract-type-ContractTypeRef		References to the contract type
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Contract type ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Contract type reference ID
‎‎ ‎ └─ client	body	subject-SubjectRef		References to the person/company
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ └─ details	body	any		Details specific to the respective contract class
	body	object
	body	any
	body	contract_details		Common properties of contract of any class
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ status	body	string		Contract status
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ name	body	string		Contract name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ dates	body	object
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ creation	body	contract_details-TimeAndBusinessDay
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ time	body	string(date-time)		System time
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ businessDay	body	string(date)		Business day
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ activation	body	contract_details-TimeAndBusinessDay
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ finish	body	contract_details-TimeAndBusinessDay
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ closure	body	contract_details-TimeAndBusinessDay
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ usageRestriction	body	any		Usage restriction applied to the contract, e.g. due to delinquency state etc.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ restrictionsProfile	body	restriction-RestrictionProfileRef		References to the restriction profile
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Restriction profile internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Restriction profile reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ sharedTariffPlan	body	contract-type-TariffPlanRef		References to default (shared) tariff plan
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ guid	body	string		Tariff plan GUID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Tariff plan reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
	body	object		Notification contract details. Notification contract describes how the system notifies customers about transactions, events, etc. The customer should have its active notification subscription, which is part of the notification contract. Subscription has different parameters to control and manage respective notifications.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ subscriptions	body	[object]		List of notification subscriptions
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Subscription ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ type	body	notification-type-NotificationTypeRef		References to the notification type
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Notification type ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Notification type reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ status	body	string		Subscription status
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ allowedAddressesIds	body	[integer]		Delivery channel IDs allowed. A value of null indicates that all of addresses are allowed.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ begSendTime	body	integer		The system will not send notifications before this time (as the number of minutes after 00:00). For example, 420 means that the system will not send notifications before 7 AM (7*60).
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ endSendTime	body	integer		The system will not send notifications after this time (as the number of minutes after 00:00). For example, 1200 means that the system will not send notifications after 8 PM (20*60).
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ options	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addresses	body	[object]		Notification channel details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Channel ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ isActive	body	boolean		Channel status. A value of true means that the channel is active.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ channelKind	body	string		Channel type
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ address	body	string		Notification delivery address, e.g. phone number, email, etc. For push notifications, contains the application address. A value of null means that the customer's contact information will be used.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ deviceName	body	string		Device name as used for push notifications
	body	any
	body	contract_details		Common properties of contract of any class
	body	object		Merchant service contract details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ settlementContract	body	contract-ContractRef		References to the contract
	body	any
	body	contract_details		Common properties of contract of any class
	body	object		Merchant settlement contract details
	body	any
	body	contract_details		Common properties of contract of any class
	body	object		Revolving credit contract additional details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mainCcy	body	string		Contract currency (Alpha3 currency code). For multi-currency contracts, it is the main currency of the contract.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cclBaseAmt	body	number		Contract credit limit. This is the common base value of the maximum credit amount allowed. Some credit contracts can also have other special credit limits, e.g. for debt categories. Please refer to the credit contracts configuration in TX for more detials.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cclTmpAmt	body	number		Temporary credit limit. Once set, is effective during the specified period of time and replaces the base credit limit.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cclTmpPeriodBeg	body	string(date-time)		Temporary credit limit, effective from
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cclTmpPeriodEnd	body	string(date-time)		Temporary credit limit, effective to
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ balances	body	object		Contract balances
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ available	body	number		Available balance (account balance – debit holds/used credit + own funds)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ ownAvailable	body	number		Own funds available balance (if applicable). For some products, credit contract allows to have customer's own funds on the balance.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ ledger	body	number		Lenger balance (account balance + credit holds)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ financial	body	number		Account balance
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ curCreditHolds	body	number		Credit holds, total
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ curDebitHold	body	number		Debit holds, total
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ debt	body	number		Debt amount, total
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ creditLimit	body	number		Current credit limit. This balance represents the current effective credit limit value, considering active temporary limit and contract's current restrictions.
	body	any
	body	contract_details		Common properties of contract of any class
	body	object		\"Shadow" contract details. "Shadow" contract represents the case with the current account when the other system (e.g. Core-banking system) manages the actual account balance, while TX only manages cards and stores account common properties. Usually, such scenario requires an online integration with the account management system to authorize operations and change of the balance.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mainCcy	body	string		Contract currency (Alpha3 currency code). For multi-currency contracts, it is the main currency of the contract.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ permOverdraft	body	number		Permitted overdraft value, if allowed
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ tmpOverdraft	body	number		Temporary overdraft value allowed
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ tmpOverdraftExpiration	body	string(date-time)		Temporary overdraft expiration date and time, if applicable
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ balances	body	object		Account balances
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ available	body	number		Available balance (account balance – debit holds)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ ledger	body	number		Lenger balance (account balance + credit holds)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ financial	body	number		Account balance
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ curCreditHolds	body	number		Credit holds, total
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ curDebitHold	body	number		Debit holds, total
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ permittedOverdraft	body	number		Overdraft amount, available (if applicable)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ debt	body	number		Debt amount, total (if applicable)
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-ModifyTranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

DELETEDelete contract

DELETE /tx/v1/contract

Deletes existing contract

Parameters

Name	In	Type	Required	Description
ref	query	contract-ContractRef	✔	Reference to the contract

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

PUTUpdate balances

PUT /tx/v1/contract/balance

Sets balance of the contract. Contracts (accounts) in TX may have different balances depending on the type of the account/product, e.g. debit card and credit card have different type of balances. Please refer to current TX configuration to get more details on how to set specific balance for the account.

Request body

{
  "balance": 500,
  "lastImpacted": {
    "day": "2019-08-24",
    "tranId": 76535367387
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
ref	query	contract-ContractRef	✔	Reference to the contract
accountRole	query	string	✔	Role of the account to set the balance to. Contracts in TX may contain several accounts e.g. to handle different balances/buckets, so it is required to select the specific account (role) to set/update the balance.
ccy	query	string	✔	Balance currency (Alpha3 currency code)
body	body	object
└─ balance	body	number		Balance value
└─ lastImpacted	body	object		Details on the balance last impact
‎‎ ‎ └─ day	body	string(date)		Date of the last impact
‎‎ ‎ └─ tranId	body	integer		Transaction ID of the last impact
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-ModifyTranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTActivate contract

POST /tx/v1/contract/activate

Activates the contract. Contracts should be activated before they can process and handle business operations.

Request body

{
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
ref	query	contract-ContractRef	✔	Reference to the contract
body	body	object
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTClose contract

POST /tx/v1/contract/close

Closes the contract. Some types of contracts require to be prepared for closure before you can close them.

Request body

{
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
ref	query	contract-ContractRef	✔	Reference to the contract
body	body	object
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTPrepare contract for closure

POST /tx/v1/contract/finish

Finalizes the contract (prepares the contract for closure). Some types of contracts (e.g. credit contracts) require to be prepared for closure first before you can close them.

Request body

{
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
ref	query	contract-ContractRef	✔	Reference to the contract
body	body	object
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTGenerate statement

POST /tx/v1/contract/statement

Generates and returns statement data/document for the contract/account. This endpoint returns the statement details specific to the selected contract type. Statement parameters and configuration are defined by respective TX settings. Basically, the TX will generate and return the statement document, e.g. PDF with all the details as required by the respective business product (i.e. debit, credit, etc.). Alternatively, the system can generate and return machine-readable data, in case if your front-end system wants to build and present a custom human-readable statement to customers. In this case, the statement type should have user-defined format and the statement data must be generated by user-defined function instead of a report class. Please check the respective statement type configuration parameters in TX. (!) Do not confuse this with the "transaction history", which is a different endpoint.

Request body

{
  "statementTypeRid": "STRID456",
  "attachmentTypeId": 10,
  "attachmentTypeRid": "ATTRID45",
  "fromDay": "2019-08-24",
  "toDay": "2019-08-24",
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
ref	query	contract-ContractRef	✔	Reference to the contract
body	body	object
└─ statementTypeRid	body	string		Statement type reference ID
└─ attachmentTypeId	body	integer		Attachment type internal ID
└─ attachmentTypeRid	body	string		Attachment type reference ID.
└─ fromDay	body	string(date)		Statement data period - start date (if applicable)
└─ toDay	body	string(date)		Statement data period - end date (if applicable)
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

GETList cards for account

GET /tx/v1/contract/cards

Lists cards that have access to the financial contract (account). This endpoint supports filtering.

Parameters

Name	In	Type	Required	Description
contract	query	contract-ContractRef	✔	Reference to the contract
filter	query	object		Filtering criteria. Refer to Filtering chapter to get more details on parameter usage.

Example responses

200 Response

[
  {
    "linkStatus": "string",
    "cardName": "string",
    "card": {
      "id": 13579,
      "rid": "CRDRID24680"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Contains the returned cards

Name	Type	Required	Restrictions	Description
└─ linkStatus	string			Card-to-account link status
└─ cardName	string			Name of the card-to-account link
└─ card	card-CardRef			References to the card
‎‎ ‎ └─ id	integer			Card internal ID
‎‎ ‎ └─ rid	string			Card reference ID

GETList customer contracts (accounts)

GET /tx/v1/contracts

Lists contracts of a customer. This endpoint supports filtering, sorting and pagination.

Parameters

Name	In	Type	Required	Description
filter	query	ContractsFilter		Filtering criteria. Refer to Filtering chapter to get more details on parameter usage.
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.
order	query	ContractsOrder		Sorting parameters. Refer to Sorting chapter to get more details on parameter usage.

order ─ Enumerated Value

Value
IdAsc
IdDesc

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": 4680,
        "rid": "CRID4542809",
        "extRid": "CASA1268"
      },
      "className": "Contract.Shadow",
      "type": {
        "id": 97548,
        "rid": "CTRID975"
      },
      "client": {
        "id": 1746,
        "rid": "PRID73"
      },
      "details": {},
      "userAttrs": [
        {
          "rid": "UDPRID3",
          "val": "VAL-1"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[contract]			Contains the returned contracts
‎‎ ‎ └─ ref	contract-ContractRef			References to the contract
‎‎ ‎ ‎‎ ‎ └─ id	integer			Contract internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Contract reference ID
‎‎ ‎ ‎‎ ‎ └─ extRid	string			Contract external reference ID
‎‎ ‎ └─ className	string			Contract class
‎‎ ‎ └─ type	contract-type-ContractTypeRef			References to the contract type
‎‎ ‎ ‎‎ ‎ └─ id	integer			Contract type ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Contract type reference ID
‎‎ ‎ └─ client	subject-SubjectRef			References to the person/company
‎‎ ‎ ‎‎ ‎ └─ id	integer			Internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ └─ details	any			Details specific to the respective contract class

anyOf

Name	Type	Required	Restrictions	Description
	object

or

Name	Type	Required	Restrictions	Description
	any

allOf

Name	Type	Required	Restrictions	Description
	contract_details			Common properties of contract of any class
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ status	string			Contract status
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ name	string			Contract name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ dates	object
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ creation	contract_details-TimeAndBusinessDay
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ time	string(date-time)			System time
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ businessDay	string(date)			Business day
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ activation	contract_details-TimeAndBusinessDay
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ finish	contract_details-TimeAndBusinessDay
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ closure	contract_details-TimeAndBusinessDay
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ usageRestriction	any			Usage restriction applied to the contract, e.g. due to delinquency state etc.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ restrictionsProfile	restriction-RestrictionProfileRef			References to the restriction profile
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Restriction profile internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Restriction profile reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ sharedTariffPlan	contract-type-TariffPlanRef			References to default (shared) tariff plan
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ guid	string			Tariff plan GUID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Tariff plan reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ userAttrs	[common-UserAttr]			Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ val	string			Value

and

Name	Type	Required	Restrictions	Description
	object			Notification contract details. Notification contract describes how the system notifies customers about transactions, events, etc. The customer should have its active notification subscription, which is part of the notification contract. Subscription has different parameters to control and manage respective notifications.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ subscriptions	[object]			List of notification subscriptions
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Subscription ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ type	notification-type-NotificationTypeRef			References to the notification type
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Notification type ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Notification type reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ status	string			Subscription status
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ allowedAddressesIds	[integer]			Delivery channel IDs allowed. A value of null indicates that all of addresses are allowed.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ begSendTime	integer			The system will not send notifications before this time (as the number of minutes after 00:00). For example, 420 means that the system will not send notifications before 7 AM (7*60).
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ endSendTime	integer			The system will not send notifications after this time (as the number of minutes after 00:00). For example, 1200 means that the system will not send notifications after 8 PM (20*60).
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ options	[common-UserAttr]			Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addresses	[object]			Notification channel details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Channel ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ isActive	boolean			Channel status. A value of true means that the channel is active.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ channelKind	string			Channel type
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ address	string			Notification delivery address, e.g. phone number, email, etc. For push notifications, contains the application address. A value of null means that the customer's contact information will be used.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ deviceName	string			Device name as used for push notifications

or

Name	Type	Required	Restrictions	Description
	any

allOf

Name	Type	Required	Restrictions	Description
	contract_details			Common properties of contract of any class

and

Name	Type	Required	Restrictions	Description
	object			Merchant service contract details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ settlementContract	contract-ContractRef			References to the contract

or

Name	Type	Required	Restrictions	Description
	any

allOf

Name	Type	Required	Restrictions	Description
	contract_details			Common properties of contract of any class

and

Name	Type	Required	Restrictions	Description
	object			Merchant settlement contract details

or

Name	Type	Required	Restrictions	Description
	any

allOf

Name	Type	Required	Restrictions	Description
	contract_details			Common properties of contract of any class

and

Name	Type	Required	Restrictions	Description
	object			Revolving credit contract additional details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mainCcy	string			Contract currency (Alpha3 currency code). For multi-currency contracts, it is the main currency of the contract.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cclBaseAmt	number			Contract credit limit. This is the common base value of the maximum credit amount allowed. Some credit contracts can also have other special credit limits, e.g. for debt categories. Please refer to the credit contracts configuration in TX for more detials.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cclTmpAmt	number			Temporary credit limit. Once set, is effective during the specified period of time and replaces the base credit limit.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cclTmpPeriodBeg	string(date-time)			Temporary credit limit, effective from
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cclTmpPeriodEnd	string(date-time)			Temporary credit limit, effective to
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ balances	object			Contract balances
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ available	number			Available balance (account balance – debit holds/used credit + own funds)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ ownAvailable	number			Own funds available balance (if applicable). For some products, credit contract allows to have customer's own funds on the balance.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ ledger	number			Lenger balance (account balance + credit holds)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ financial	number			Account balance
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ curCreditHolds	number			Credit holds, total
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ curDebitHold	number			Debit holds, total
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ debt	number			Debt amount, total
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ creditLimit	number			Current credit limit. This balance represents the current effective credit limit value, considering active temporary limit and contract's current restrictions.

or

Name	Type	Required	Restrictions	Description
	any

allOf

Name	Type	Required	Restrictions	Description
	contract_details			Common properties of contract of any class

and

Name	Type	Required	Restrictions	Description
	object			\"Shadow" contract details. "Shadow" contract represents the case with the current account when the other system (e.g. Core-banking system) manages the actual account balance, while TX only manages cards and stores account common properties. Usually, such scenario requires an online integration with the account management system to authorize operations and change of the balance.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mainCcy	string			Contract currency (Alpha3 currency code). For multi-currency contracts, it is the main currency of the contract.
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ permOverdraft	number			Permitted overdraft value, if allowed
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ tmpOverdraft	number			Temporary overdraft value allowed
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ tmpOverdraftExpiration	string(date-time)			Temporary overdraft expiration date and time, if applicable
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ balances	object			Account balances
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ available	number			Available balance (account balance – debit holds)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ ledger	number			Lenger balance (account balance + credit holds)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ financial	number			Account balance
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ curCreditHolds	number			Credit holds, total
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ curDebitHold	number			Debit holds, total
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ permittedOverdraft	number			Overdraft amount, available (if applicable)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ debt	number			Debt amount, total (if applicable)

continued

Name	Type	Required	Restrictions	Description
‎‎ ‎ └─ userAttrs	[common-UserAttr]			Container of user-defined attributes

GETGet contract-to-contract link

GET /tx/v1/contract2contract

Retrieves contract-to-contract link details

Parameters

Name	In	Type	Required	Description
id	query	integer	✔	Link ID

Example responses

200 Response

{
  "id": 897592,
  "contract1": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "contract1Name": "Digital card",
  "contract2": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "contract2Name": "Revolving",
  "kind": "string",
  "status": "string",
  "seq": 1
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	contract2contract
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

PUTCreate or update contract-to-contract link

PUT /tx/v1/contract2contract

Creates new or updates an existing contract-to-contract link

Request body

{
  "id": 897592,
  "contract1": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "contract1Name": "Digital card",
  "contract2": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "contract2Name": "Revolving",
  "kind": "string",
  "status": "string",
  "seq": 1
}

Parameters

Name	In	Type	Required	Description
mustExist	query	boolean		Object presence control. Refer to Idempotency chapter to get more details on parameter usage.
body	body	contract2contract
└─ id	body	integer		Link ID
└─ contract1	body	contract-ContractRef		References to the contract
‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ └─ extRid	body	string		Contract external reference ID
└─ contract1Name	body	string		The first contract name
└─ contract2	body	contract-ContractRef		References to the contract
└─ contract2Name	body	string		The second contract name
└─ kind	body	string		Link type
└─ status	body	string		Link status
└─ seq	body	integer		Link sequence number in contract1

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-ModifyTranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

DELETEDelete contract-to-contract link

DELETE /tx/v1/contract2contract

Deletes existing contract-to-contract link

Parameters

Name	In	Type	Required	Description
id	query	integer	✔	Link ID

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

GETList contract-to-contract links

GET /tx/v1/contract2contracts

Gets the list of contract-to-contract links. This endpoint supports filtering, sorting and pagination.

Parameters

Name	In	Type	Required	Description
filter	query	Contract2ContractsFilter		Filtering criteria. Refer to Filtering chapter to get more details on parameter usage.
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.
order	query	Contract2ContractsOrder		Sorting parameters. Refer to Sorting chapter to get more details on parameter usage.

order ─ Enumerated Value

Value
IdAsc
IdDesc
SeqAsc
SeqDesc

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "id": 897592,
      "contract1": {
        "id": 4680,
        "rid": "CRID4542809",
        "extRid": "CASA1268"
      },
      "contract1Name": "Digital card",
      "contract2": {
        "id": 4680,
        "rid": "CRID4542809",
        "extRid": "CASA1268"
      },
      "contract2Name": "Revolving",
      "kind": "string",
      "status": "string",
      "seq": 1
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[contract2contract]			Contains the returned links
‎‎ ‎ └─ id	integer			Link ID
‎‎ ‎ └─ contract1	contract-ContractRef			References to the contract
‎‎ ‎ ‎‎ ‎ └─ id	integer			Contract internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Contract reference ID
‎‎ ‎ ‎‎ ‎ └─ extRid	string			Contract external reference ID
‎‎ ‎ └─ contract1Name	string			The first contract name
‎‎ ‎ └─ contract2	contract-ContractRef			References to the contract
‎‎ ‎ └─ contract2Name	string			The second contract name
‎‎ ‎ └─ kind	string			Link type
‎‎ ‎ └─ status	string			Link status
‎‎ ‎ └─ seq	integer			Link sequence number in contract1

GETList contract types

GET /tx/v1/contract-types

Gets the list of contract types available. This endpoint supports pagination.

Parameters

Name	In	Type	Required	Description
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": 97548,
        "rid": "CTRID975"
      },
      "name": "Revolving credit",
      "contractClassName": "Credit contracts",
      "isAbstract": true,
      "parentType": {
        "id": 97548,
        "rid": "CTRID975"
      },
      "tariffPlans": [
        {
          "ref": {
            "guid": "NPW63LQE2BFWPAQBET4DQIDYNY",
            "rid": "TPRID963"
          },
          "name": "Common pricing plan"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[contract-type]			Contains the returned contract types
‎‎ ‎ └─ ref	contract-type-ContractTypeRef			References to the contract type
‎‎ ‎ ‎‎ ‎ └─ id	integer			Contract type ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Contract type reference ID
‎‎ ‎ └─ name	string			Contract type name
‎‎ ‎ └─ contractClassName	string			Contract class name
‎‎ ‎ └─ isAbstract	boolean			Indicates if the contract type can be used to create contracts of that type. A value of true indicates that the contract type is abstract and is only used to build a hierarchy of contract types.
‎‎ ‎ └─ parentType	contract-type-ContractTypeRef			References to the contract type
‎‎ ‎ └─ tariffPlans	[contract-type-TariffPlan]			Default pricing parameters (tariff plans) for the business product, used by all contracts of that type
‎‎ ‎ ‎‎ ‎ └─ ref	contract-type-TariffPlanRef			References to default (shared) tariff plan
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ guid	string			Tariff plan GUID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Tariff plan reference ID
‎‎ ‎ ‎‎ ‎ └─ name	string			Tariff plan name

POSTPerform user-defined operation 0

POST /tx/v1/custom-operation-0/{function}

Performs custom operation (number 0). Custom (user-defined) operations can be used to implement non-standard business logic or user-defined actions when standard operations and endpoints are not enough. There are several endpoints available (0-9) to implement/call such operations. Such user-defined operations are implemented in TX as user-defined functions (UDF) and user-defined transactions (UDT). Parameters can be passed in request body in JSON format. Please also check TX configuration for more details.

Request body

{
  "param_1": "Value 123"
}

Parameters

Name	In	Type	Required	Description
function	path	string	✔	User-defined function unique name to distinguish user-defined functions
body	body	object

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not found	Inline
422	Unprocessable Entity	Operation declined	Inline
500	Internal Server Error	Internal server error

Response Schema

POSTPerform user-defined operation 1

POST /tx/v1/custom-operation-1/{function}

Performs custom operation (number 1). Please refer to custom operation 0 endpoint for more details.

Request body

{}

Parameters

Name	In	Type	Required	Description
function	path	string	✔
body	body	object

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not found	Inline
422	Unprocessable Entity	Operation declined	Inline
500	Internal Server Error	Internal server error

Response Schema

POSTPerform user-defined operation 2

POST /tx/v1/custom-operation-2/{function}

Performs custom operation (number 2). Please refer to custom operation 0 endpoint for more details.

Request body

{}

Parameters

Name	In	Type	Required	Description
function	path	string	✔
body	body	object

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not found	Inline
422	Unprocessable Entity	Operation declined	Inline
500	Internal Server Error	Internal server error

Response Schema

POSTPerform user-defined operation 3

POST /tx/v1/custom-operation-3/{function}

Performs custom operation (number 3). Please refer to custom operation 0 endpoint for more details.

Request body

{}

Parameters

Name	In	Type	Required	Description
function	path	string	✔
body	body	object

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not found	Inline
422	Unprocessable Entity	Operation declined	Inline
500	Internal Server Error	Internal server error

Response Schema

POSTPerform user-defined operation 4

POST /tx/v1/custom-operation-4/{function}

Performs custom operation (number 4). Please refer to custom operation 0 endpoint for more details.

Request body

{}

Parameters

Name	In	Type	Required	Description
function	path	string	✔
body	body	object

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not found	Inline
422	Unprocessable Entity	Operation declined	Inline
500	Internal Server Error	Internal server error

Response Schema

POSTPerform user-defined operation 5

POST /tx/v1/custom-operation-5/{function}

Performs custom operation (number 5). Please refer to custom operation 0 endpoint for more details.

Request body

{}

Parameters

Name	In	Type	Required	Description
function	path	string	✔
body	body	object

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not found	Inline
422	Unprocessable Entity	Operation declined	Inline
500	Internal Server Error	Internal server error

Response Schema

POSTPerform user-defined operation 6

POST /tx/v1/custom-operation-6/{function}

Performs custom operation (number 6). Please refer to custom operation 0 endpoint for more details.

Request body

{}

Parameters

Name	In	Type	Required	Description
function	path	string	✔
body	body	object

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not found	Inline
422	Unprocessable Entity	Operation declined	Inline
500	Internal Server Error	Internal server error

Response Schema

POSTPerform user-defined operation 7

POST /tx/v1/custom-operation-7/{function}

Performs custom operation (number 7). Please refer to custom operation 0 endpoint for more details.

Request body

{}

Parameters

Name	In	Type	Required	Description
function	path	string	✔
body	body	object

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not found	Inline
422	Unprocessable Entity	Operation declined	Inline
500	Internal Server Error	Internal server error

Response Schema

POSTPerform user-defined operation 8

POST /tx/v1/custom-operation-8/{function}

Performs custom operation (number 8). Please refer to custom operation 0 endpoint for more details.

Request body

{}

Parameters

Name	In	Type	Required	Description
function	path	string	✔
body	body	object

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not found	Inline
422	Unprocessable Entity	Operation declined	Inline
500	Internal Server Error	Internal server error

Response Schema

POSTPerform user-defined operation 9

POST /tx/v1/custom-operation-9/{function}

Performs custom operation (number 9). Please refer to custom operation 0 endpoint for more details.

Request body

{}

Parameters

Name	In	Type	Required	Description
function	path	string	✔
body	body	object

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not found	Inline
422	Unprocessable Entity	Operation declined	Inline
500	Internal Server Error	Internal server error

Response Schema

GETList notification types

GET /tx/v1/notification-types

Lists notification types configured in the system. This endpoint supports pagination.

Parameters

Name	In	Type	Required	Description
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": 87648,
        "rid": "NTRID878"
      },
      "name": "OTP",
      "className": "Base Notifications",
      "parentType": {
        "id": 87648,
        "rid": "NTRID878"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[notification-type]			Contains the returned notification types
‎‎ ‎ └─ ref	notification-type-NotificationTypeRef			References to the notification type
‎‎ ‎ ‎‎ ‎ └─ id	integer			Notification type ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Notification type reference ID
‎‎ ‎ └─ name	string			Notification type name
‎‎ ‎ └─ className	string			Notification type class (=Notification Contract Type)
‎‎ ‎ └─ parentType	notification-type-NotificationTypeRef			References to the notification type

GETGet question-answer pair

GET /tx/v1/subject-auth_qa

Retrieves question and answer details for person authentication.

Parameters

Name	In	Type	Required	Description
person	query	subject-SubjectRef	✔	Reference to the person
question	query	string	✔	Question that the answer is required to. The question's text is case-sensitive.

Example responses

200 Response

{
  "question": "First pet name",
  "answer": "Rocket"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	subject-auth_qa
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

PUTCreate or update question-answer pair

PUT /tx/v1/subject-auth_qa

Creates new or updates an existing question-answer pair

Request body

{
  "object": {
    "question": "First pet name",
    "answer": "Rocket"
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
person	query	subject-SubjectRef	✔	Reference to the person
body	body	object
└─ object	body	subject-auth_qa		Personal authentication question and answer (security questions)
‎‎ ‎ └─ question	body	string		Personal authentication question
‎‎ ‎ └─ answer	body	string		Personal authentication answer
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

DELETEDelete question-answer pair

DELETE /tx/v1/subject-auth_qa

Deletes existing question-answer pair for the person

Parameters

Name	In	Type	Required	Description
person	query	subject-SubjectRef	✔	Reference to the person
question	query	string	✔	Question to delete. The question's text is case-sensitive.

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

GETList question-answer pairs for the person

GET /tx/v1/subject-auth_qas

Gets the list of authentication question-answer pairs for a customer. This endpoint supports pagination.

Parameters

Name	In	Type	Required	Description
person	query	subject-SubjectRef	✔	Reference to the person
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "question": "First pet name",
      "answer": "Rocket"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[subject-auth_qa]			Contains the returned question-answer pairs
‎‎ ‎ └─ question	string			Personal authentication question
‎‎ ‎ └─ answer	string			Personal authentication answer

GETGet restriction

GET /tx/v1/restriction

Retrieves restriction details by the reference.

Parameters

Name	In	Type	Required	Description
ref	query	restriction-RestrictionRef	✔	Reference to the restriction
owner	query	restriction-OwnerRef	✔	Reference to the restriction's owner

Example responses

200 Response

{
  "ref": {
    "guid": "7febf16f651b43b0a5e30da8da49e",
    "rid": "RRID0847"
  },
  "classGuid": "7febf16f651b43b0a5e30da8da49e90d",
  "name": "Daily usage limit",
  "inUse": true,
  "begTime": "2020-10-21T14:15:00",
  "endTime": "2020-10-22T14:15:00",
  "tmpOff": {
    "begTime": "2020-11-21T14:15:00",
    "endTime": "2020-11-22T14:15:00"
  },
  "maxVal": 10,
  "ccy": "USD",
  "tmpMax": {
    "val": 20,
    "begTime": "2020-10-21T14:15:00",
    "endTime": "2020-10-22T14:15:00"
  },
  "limit": {
    "reset": {
      "periodType": "string",
      "timeOffset": 1440
    },
    "windowSize": 30,
    "curVal": 3,
    "lastResetTime": "2020-10-21T14:15:00"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	restriction
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

PUTCreate or update restriction

PUT /tx/v1/restriction

Creates new or updates an existing restriction for the object. To reset the limit, set its current value to "0" (limit.curVal).

Request body

{
  "object": {
    "ref": {
      "guid": "7febf16f651b43b0a5e30da8da49e",
      "rid": "RRID0847"
    },
    "classGuid": "7febf16f651b43b0a5e30da8da49e90d",
    "name": "Daily usage limit",
    "inUse": true,
    "begTime": "2020-10-21T14:15:00",
    "endTime": "2020-10-22T14:15:00",
    "tmpOff": {
      "begTime": "2020-11-21T14:15:00",
      "endTime": "2020-11-22T14:15:00"
    },
    "maxVal": 10,
    "ccy": "USD",
    "tmpMax": {
      "val": 20,
      "begTime": "2020-10-21T14:15:00",
      "endTime": "2020-10-22T14:15:00"
    },
    "limit": {
      "reset": {
        "periodType": "string",
        "timeOffset": 1440
      },
      "windowSize": 30,
      "curVal": 3,
      "lastResetTime": "2020-10-21T14:15:00"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
owner	query	restriction-OwnerRef	✔	Reference to the restriction's owner. To modify the restriction, use restriction object ref parameters in the request body.
body	body	object
└─ object	body	restriction		Restriction object. Restriction object in TX represents different limits, counters and other restrictions that can be applied to cards (tokens), accounts (contracts), customers (subjects) and terminals to control operations, e.g. velocity control limits, permitted transaction types, etc. Restrictions are combined in restriction/risk profiles, that groups limitations of the same category, e.g. "contract restriction profile" is applied to contracts, "card/token risk profile" is applied to cards, etc.
‎‎ ‎ └─ ref	body	restriction-RestrictionRef		References to the restriction/limit
‎‎ ‎ ‎‎ ‎ └─ guid	body	string		Restriction internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Restriction reference ID
‎‎ ‎ └─ classGuid	body	string		Restriction class unique identifier
‎‎ ‎ └─ name	body	string		Restriction name (description)
‎‎ ‎ └─ inUse	body	boolean		Indicates if the restriction is active. A value of true indicates that the restriction is currently in use.
‎‎ ‎ └─ begTime	body	string(date-time)		Restriction effective time, from
‎‎ ‎ └─ endTime	body	string(date-time)		Restriction effective time, to
‎‎ ‎ └─ tmpOff	body	object		Indicates if the restriction is temporarily disabled (during the usage period)
‎‎ ‎ ‎‎ ‎ └─ begTime	body	string(date-time)		Restriction inactivity time, from
‎‎ ‎ ‎‎ ‎ └─ endTime	body	string(date-time)		Restriction inactivity time, to
‎‎ ‎ └─ maxVal	body	number		Restriction maximum value. For restriction type "limit" it is the maximum accumulated value, for other types of restrictions it is the maximum value of the transaction.
‎‎ ‎ └─ ccy	body	string		Restriction currency (alpha3 currency code)
‎‎ ‎ └─ tmpMax	body	object		Temporary maximum value parameters
‎‎ ‎ ‎‎ ‎ └─ val	body	number		Temporary maximum value
‎‎ ‎ ‎‎ ‎ └─ begTime	body	string(date-time)		Temporary maximum value effective, from
‎‎ ‎ ‎‎ ‎ └─ endTime	body	string(date-time)		Temporary maximum value effective, to
‎‎ ‎ └─ limit	body	object		Limit parameters (applicable to restrictions of "limit" type)
‎‎ ‎ ‎‎ ‎ └─ reset	body	object		Limit reset parameters
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ periodType	body	string		Limit reset period
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ timeOffset	body	integer		Reset time offset. Defined as the number of minutes after the period start.
‎‎ ‎ ‎‎ ‎ └─ windowSize	body	integer		Accumulation window. Defines how many periods will be used during accumulation.
‎‎ ‎ ‎‎ ‎ └─ curVal	body	number		Currently accumulated value
‎‎ ‎ ‎‎ ‎ └─ lastResetTime	body	string(date-time)		Date/time when the limit was reset last time
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

DELETEDelete restriction

DELETE /tx/v1/restriction

Deletes existing restriction for the object

Parameters

Name	In	Type	Required	Description
ref	query	restriction-RestrictionRef	✔	Reference to the restriction
owner	query	restriction-OwnerRef	✔	Reference to the restriction's owner

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

GETList restrictions

GET /tx/v1/restrictions

Gets the list of restrictions for an object (owner). This endpoint supports pagination.

Parameters

Name	In	Type	Required	Description
owner	query	restriction-OwnerRef	✔	Reference to the restriction's owner
onlyOwn	query	boolean		Indicates if the list should contain the owner's personal restrictions only. A value of true indicates that only personal restrictions of selected object will be returned, otherwise the full set of assigned restrictions will be returned (both personal and inherited from the product).
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "guid": "7febf16f651b43b0a5e30da8da49e",
        "rid": "RRID0847"
      },
      "classGuid": "7febf16f651b43b0a5e30da8da49e90d",
      "name": "Daily usage limit",
      "inUse": true,
      "begTime": "2020-10-21T14:15:00",
      "endTime": "2020-10-22T14:15:00",
      "tmpOff": {
        "begTime": "2020-11-21T14:15:00",
        "endTime": "2020-11-22T14:15:00"
      },
      "maxVal": 10,
      "ccy": "USD",
      "tmpMax": {
        "val": 20,
        "begTime": "2020-10-21T14:15:00",
        "endTime": "2020-10-22T14:15:00"
      },
      "limit": {
        "reset": {
          "periodType": "string",
          "timeOffset": 1440
        },
        "windowSize": 30,
        "curVal": 3,
        "lastResetTime": "2020-10-21T14:15:00"
      },
      "userAttrs": [
        {
          "rid": "UDPRID3",
          "val": "VAL-1"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[restriction]			Contains the returned restrictions
‎‎ ‎ └─ ref	restriction-RestrictionRef			References to the restriction/limit
‎‎ ‎ ‎‎ ‎ └─ guid	string			Restriction internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Restriction reference ID
‎‎ ‎ └─ classGuid	string			Restriction class unique identifier
‎‎ ‎ └─ name	string			Restriction name (description)
‎‎ ‎ └─ inUse	boolean			Indicates if the restriction is active. A value of true indicates that the restriction is currently in use.
‎‎ ‎ └─ begTime	string(date-time)			Restriction effective time, from
‎‎ ‎ └─ endTime	string(date-time)			Restriction effective time, to
‎‎ ‎ └─ tmpOff	object			Indicates if the restriction is temporarily disabled (during the usage period)
‎‎ ‎ ‎‎ ‎ └─ begTime	string(date-time)			Restriction inactivity time, from
‎‎ ‎ ‎‎ ‎ └─ endTime	string(date-time)			Restriction inactivity time, to
‎‎ ‎ └─ maxVal	number			Restriction maximum value. For restriction type "limit" it is the maximum accumulated value, for other types of restrictions it is the maximum value of the transaction.
‎‎ ‎ └─ ccy	string			Restriction currency (alpha3 currency code)
‎‎ ‎ └─ tmpMax	object			Temporary maximum value parameters
‎‎ ‎ ‎‎ ‎ └─ val	number			Temporary maximum value
‎‎ ‎ ‎‎ ‎ └─ begTime	string(date-time)			Temporary maximum value effective, from
‎‎ ‎ ‎‎ ‎ └─ endTime	string(date-time)			Temporary maximum value effective, to
‎‎ ‎ └─ limit	object			Limit parameters (applicable to restrictions of "limit" type)
‎‎ ‎ ‎‎ ‎ └─ reset	object			Limit reset parameters
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ periodType	string			Limit reset period
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ timeOffset	integer			Reset time offset. Defined as the number of minutes after the period start.
‎‎ ‎ ‎‎ ‎ └─ windowSize	integer			Accumulation window. Defines how many periods will be used during accumulation.
‎‎ ‎ ‎‎ ‎ └─ curVal	number			Currently accumulated value
‎‎ ‎ ‎‎ ‎ └─ lastResetTime	string(date-time)			Date/time when the limit was reset last time
‎‎ ‎ └─ userAttrs	[common-UserAttr]			Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	string			Value

GETGet person or company

GET /tx/v1/subject

Retrieves subject details by a reference.

Parameters

Name	In	Type	Required	Description
ref	query	subject-SubjectRef	✔	Reference to the person or company

Example responses

200 Response

{
  "ref": {
    "id": 1746,
    "rid": "PRID73"
  },
  "type": {
    "id": 564,
    "rid": "STRID23"
  },
  "kind": "Person",
  "details": {},
  "networkSpec": [
    {
      "networkName": "string",
      "toDelete": true,
      "rid": "string",
      "merchantRid": "string",
      "singleMerchantRid": "string",
      "name": "string",
      "mcc": "string"
    }
  ],
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	subject
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

PUTCreate or update person or company

PUT /tx/v1/subject

Creates new or updates an existing person or company

Request body

{
  "object": {
    "ref": {
      "id": 1746,
      "rid": "PRID73"
    },
    "type": {
      "id": 564,
      "rid": "STRID23"
    },
    "kind": "Person",
    "details": {},
    "networkSpec": [
      {
        "networkName": "string",
        "toDelete": true,
        "rid": "string",
        "merchantRid": "string",
        "singleMerchantRid": "string",
        "name": "string",
        "mcc": "string"
      }
    ],
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
mustExist	query	boolean		Object presence control. Refer to Idempotency chapter to get more details on parameter usage.
body	body	object
└─ object	body	subject		Subject (person, company)
‎‎ ‎ └─ ref	body	subject-SubjectRef		References to the person/company
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ └─ type	body	subject-type-SubjectTypeRef		Reference to the subject type
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Subject type ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Subject type reference ID
‎‎ ‎ └─ kind	body	subject-SubjectKind		Kind of the subject
‎‎ ‎ └─ details	body	any
	body	object		Details specific to the respective subject class
	body	any
	body	subject_details		Common properties of subject of any kind
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mailAddress	body	common-Address		Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ zip	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ country	body	integer		ISO numeric code
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ region	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ regionRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ area	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ areaRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ city	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cityRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ street	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ streetRid	body	string		RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ house	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ building	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ construction	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ flat	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCity	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCountry	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ recipientName	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ phone	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ fax	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mobile	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ email	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ url	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ languageCode	body	string		Contact language (ISO alpha-2 language code)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ locale	body	string		Communication locale (IETF language tag)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ status	body	string		Person/company status in TX
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ notificationContractId	body	integer		In case if the person/company has active notification subscriptions, the internal ID of the currently active notification contract (also refer to "contract" object for more details)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
	body	object		Company or corporate customer details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ parent	body	subject-SubjectRef		References to the person/company
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ name	body	string		Company full name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ shortName	body	string		Company short name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ legalName	body	string		Company legal name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ latName	body	string		Company name in latin
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ address	body	common-Address		Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ legalAddress	body	common-Address		Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mailAddress	body	common-Address		Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mcc	body	integer		Merchant category code
	body	any
	body	subject_details		Common properties of subject of any kind
	body	object		Person or individual customer details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ lastName	body	string		Last name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ firstName	body	string		First name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ middleName	body	string		Middle name (if applicable)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ birthDate	body	string(date)		Birth date
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ gender	body	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ residenceCountry	body	integer		Country of residence (ISO numeric code)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ citizenshipCountry	body	integer		Country of citizenship, main (ISO numeric code)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ extraCitizenships	body	[integer]		Countries of citizenship, others (ISO numeric code)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ regAddress	body	common-Address		Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ homeAddress	body	common-Address		Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ emails	body	[string]		List of e-mails
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ phones	body	[string]		List of contact phones
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ workPhones	body	[string]		List of work phones
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ restrictionsProfile	body	restriction-RestrictionProfileRef		References to the restriction profile
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Restriction profile internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Restriction profile reference ID
‎‎ ‎ └─ networkSpec	body	[subject-NetworkSpecAttr]		List of metwork-specific attributes
‎‎ ‎ ‎‎ ‎ └─ networkName	body	string		Network name
‎‎ ‎ ‎‎ ‎ └─ toDelete	body	boolean		Delete this attribute
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ merchantRid	body	string		Merchant reference ID
‎‎ ‎ ‎‎ ‎ └─ singleMerchantRid	body	string		Single merchant reference ID
‎‎ ‎ ‎‎ ‎ └─ name	body	string		Name
‎‎ ‎ ‎‎ ‎ └─ mcc	body	string		MCC
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-ModifyTranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

DELETEDelete person or company

DELETE /tx/v1/subject

Deletes existing person or company

Parameters

Name	In	Type	Required	Description
ref	query	subject-SubjectRef	✔	Reference to the person or company

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTSend notification to customer

POST /tx/v1/subject/notification

Sends notification to customer via selected channel e.g. SMS, e-mail, push

Request body

{
  "channelKind": "string",
  "address": "one21@mail.net",
  "messageSubject": "Information",
  "messageBody": "Welcome to the club!"
}

Parameters

Name	In	Type	Required	Description
subject	query	subject-SubjectRef		Reference to the customer, if available
body	body	object
└─ channelKind	body	string		Type of the delivery channel
└─ address	body	string		Mobile phone number, email address, etc.
└─ messageSubject	body	string		Subject of the message
└─ messageBody	body	string		Message body

Responses

Status	Meaning	Description	Schema
200	OK	OK
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

GETList subjects

GET /tx/v1/subjects

Gets the list of subjects (persons or companies). This endpoint supports filtering, sorting and pagination.

Parameters

Name	In	Type	Required	Description
filter	query	SubjectsFilter		Filtering criteria. Refer to Filtering chapter to get more details on parameter usage.
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.
order	query	SubjectsOrder		Sorting parameters. Refer to Sorting chapter to get more details on parameter usage.

order ─ Enumerated Value

Value
IdAsc
IdDesc
RidAsc
RidDesc
NameAsc
NameDesc

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": 1746,
        "rid": "PRID73"
      },
      "type": {
        "id": 564,
        "rid": "STRID23"
      },
      "kind": "Person",
      "details": {},
      "networkSpec": [
        {
          "networkName": "string",
          "toDelete": true,
          "rid": "string",
          "merchantRid": "string",
          "singleMerchantRid": "string",
          "name": "string",
          "mcc": "string"
        }
      ],
      "userAttrs": [
        {
          "rid": "UDPRID3",
          "val": "VAL-1"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[subject]			Contains the returned subjects
‎‎ ‎ └─ ref	subject-SubjectRef			References to the person/company
‎‎ ‎ ‎‎ ‎ └─ id	integer			Internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ └─ type	subject-type-SubjectTypeRef			Reference to the subject type
‎‎ ‎ ‎‎ ‎ └─ id	integer			Subject type ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Subject type reference ID
‎‎ ‎ └─ kind	subject-SubjectKind			Kind of the subject
‎‎ ‎ └─ details	any

anyOf

Name	Type	Required	Restrictions	Description
	object			Details specific to the respective subject class

or

Name	Type	Required	Restrictions	Description
	any

allOf

Name	Type	Required	Restrictions	Description
	subject_details			Common properties of subject of any kind
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mailAddress	common-Address			Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ zip	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ country	integer			ISO numeric code
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ region	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ regionRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ area	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ areaRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ city	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ cityRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ street	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ streetRid	string			RID in address database
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ house	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ building	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ construction	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ flat	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCity	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ addressInCountry	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ recipientName	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ phone	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ fax	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mobile	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ email	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ url	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ languageCode	string			Contact language (ISO alpha-2 language code)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ locale	string			Communication locale (IETF language tag)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ status	string			Person/company status in TX
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ notificationContractId	integer			In case if the person/company has active notification subscriptions, the internal ID of the currently active notification contract (also refer to "contract" object for more details)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ userAttrs	[common-UserAttr]			Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ val	string			Value

and

Name	Type	Required	Restrictions	Description
	object			Company or corporate customer details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ parent	subject-SubjectRef			References to the person/company
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ name	string			Company full name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ shortName	string			Company short name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ legalName	string			Company legal name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ latName	string			Company name in latin
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ address	common-Address			Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ legalAddress	common-Address			Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mailAddress	common-Address			Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mcc	integer			Merchant category code

or

Name	Type	Required	Restrictions	Description
	any

allOf

Name	Type	Required	Restrictions	Description
	subject_details			Common properties of subject of any kind

and

Name	Type	Required	Restrictions	Description
	object			Person or individual customer details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ lastName	string			Last name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ firstName	string			First name
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ middleName	string			Middle name (if applicable)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ birthDate	string(date)			Birth date
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ gender	string
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ residenceCountry	integer			Country of residence (ISO numeric code)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ citizenshipCountry	integer			Country of citizenship, main (ISO numeric code)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ extraCitizenships	[integer]			Countries of citizenship, others (ISO numeric code)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ regAddress	common-Address			Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ homeAddress	common-Address			Address and contact details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ emails	[string]			List of e-mails
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ phones	[string]			List of contact phones
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ workPhones	[string]			List of work phones
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ restrictionsProfile	restriction-RestrictionProfileRef			References to the restriction profile
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Restriction profile internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Restriction profile reference ID

continued

Name	Type	Required	Restrictions	Description
‎‎ ‎ └─ networkSpec	[subject-NetworkSpecAttr]			List of metwork-specific attributes
‎‎ ‎ ‎‎ ‎ └─ networkName	string			Network name
‎‎ ‎ ‎‎ ‎ └─ toDelete	boolean			Delete this attribute
‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ ‎‎ ‎ └─ merchantRid	string			Merchant reference ID
‎‎ ‎ ‎‎ ‎ └─ singleMerchantRid	string			Single merchant reference ID
‎‎ ‎ ‎‎ ‎ └─ name	string			Name
‎‎ ‎ ‎‎ ‎ └─ mcc	string			MCC
‎‎ ‎ └─ userAttrs	[common-UserAttr]			Container of user-defined attributes

kind ─ Enumerated Value

Value
Person
Corporation

GETGet document

GET /tx/v1/subject-document

Retrieves subject's document details

Parameters

Name	In	Type	Required	Description
ref	query	subject-document-SubjectDocumentRef	✔	Reference to the document

Example responses

200 Response

{
  "ref": {
    "id": 8737
  },
  "type": {
    "id": 56,
    "rid": "DTRID084"
  },
  "series": 7522,
  "rid": 888122,
  "issuerName": "Regional security office",
  "isActive": true,
  "issueDate": "2020-10-21",
  "expDate": "2035-10-21",
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	subject-document
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

PUTCreate or update document

PUT /tx/v1/subject-document

Creates new or updates an existing document for the subject (person or company)

Request body

{
  "object": {
    "ref": {
      "id": 8737
    },
    "type": {
      "id": 56,
      "rid": "DTRID084"
    },
    "series": 7522,
    "rid": 888122,
    "issuerName": "Regional security office",
    "isActive": true,
    "issueDate": "2020-10-21",
    "expDate": "2035-10-21",
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
subject	query	subject-SubjectRef	✔	Reference to the subject (person or company)
mustExist	query	boolean		Object presence control. Refer to Idempotency chapter to get more details on parameter usage.
body	body	object
└─ object	body	subject-document		Document object (passport, national ID, etc.)
‎‎ ‎ └─ ref	body	subject-document-SubjectDocumentRef		Reference to the document
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Document internal ID. (!) Please note, this is not the document number.
‎‎ ‎ └─ type	body	subject-document-type-SubjectDocumentTypeRef		Reference to the document type
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Document type ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Document type reference ID
‎‎ ‎ └─ series	body	string		Document series or prefix. For example, some passports can contain two parts in its number – the series and the number itself, e.g. "7500 123456" as the full passport number.
‎‎ ‎ └─ rid	body	string		Document number (reference ID)
‎‎ ‎ └─ issuerName	body	string		Entity that issued the document
‎‎ ‎ └─ isActive	body	boolean		Indicates if the document is active or not. A value of true indicates that the document is active in TX.
‎‎ ‎ └─ issueDate	body	string(date)		The date the document was issued
‎‎ ‎ └─ expDate	body	string(date)		Document expiration date
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-ModifyTranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

DELETEDelete document

DELETE /tx/v1/subject-document

Deletes subject's document

Parameters

Name	In	Type	Required	Description
ref	query	subject-document-SubjectDocumentRef	✔	Reference to the document

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

GETList documents

GET /tx/v1/subject-documents

Gets the list of documents for a person or a company. This endpoint supports filtering, sorting and pagination.

Parameters

Name	In	Type	Required	Description
filter	query	SubjectDocumentsFilter		Filtering criteria. Refer to Filtering chapter to get more details on parameter usage.
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.
order	query	SubjectDocumentsOrder		Sorting parameters. Refer to Sorting chapter to get more details on parameter usage.

order ─ Enumerated Value

Value
IdAsc
IdDesc

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": 8737
      },
      "type": {
        "id": 56,
        "rid": "DTRID084"
      },
      "series": 7522,
      "rid": 888122,
      "issuerName": "Regional security office",
      "isActive": true,
      "issueDate": "2020-10-21",
      "expDate": "2035-10-21",
      "userAttrs": [
        {
          "rid": "UDPRID3",
          "val": "VAL-1"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[subject-document]			Contains the returned documents
‎‎ ‎ └─ ref	subject-document-SubjectDocumentRef			Reference to the document
‎‎ ‎ ‎‎ ‎ └─ id	integer			Document internal ID. (!) Please note, this is not the document number.
‎‎ ‎ └─ type	subject-document-type-SubjectDocumentTypeRef			Reference to the document type
‎‎ ‎ ‎‎ ‎ └─ id	integer			Document type ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Document type reference ID
‎‎ ‎ └─ series	string			Document series or prefix. For example, some passports can contain two parts in its number – the series and the number itself, e.g. "7500 123456" as the full passport number.
‎‎ ‎ └─ rid	string			Document number (reference ID)
‎‎ ‎ └─ issuerName	string			Entity that issued the document
‎‎ ‎ └─ isActive	boolean			Indicates if the document is active or not. A value of true indicates that the document is active in TX.
‎‎ ‎ └─ issueDate	string(date)			The date the document was issued
‎‎ ‎ └─ expDate	string(date)			Document expiration date
‎‎ ‎ └─ userAttrs	[common-UserAttr]			Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	string			Value

GETList subject types

GET /tx/v1/subject-types

Gets the list of subject types available in the system. This endpoint supports pagination.

Parameters

Name	In	Type	Required	Description
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": 564,
        "rid": "STRID23"
      },
      "name": "Customer",
      "kind": "Person",
      "parentType": {
        "id": 564,
        "rid": "STRID23"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[subject-type]			Contains the returned types
‎‎ ‎ └─ ref	subject-type-SubjectTypeRef			Reference to the subject type
‎‎ ‎ ‎‎ ‎ └─ id	integer			Subject type ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Subject type reference ID
‎‎ ‎ └─ name	string			Subject type name
‎‎ ‎ └─ kind	subject-SubjectKind			Kind of the subject
‎‎ ‎ └─ parentType	subject-type-SubjectTypeRef			Reference to the subject type

kind ─ Enumerated Value

Value
Person
Corporation

GETList surcharge tariff plans

GET /tx/v1/surcharge-tariff-plans

Gets the list of available surcharge tariff plans. This endpoint supports pagination.

Parameters

Name	In	Type	Required	Description
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": "BHUMNF5OOJEH7AWVPAHS2OY6XYXX",
        "rid": "TP23"
      },
      "name": "Common"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[surcharge-tariff-plan]			Contains the returned objects
‎‎ ‎ └─ ref	surcharge-tariff-plan-SurchargeTariffPlanRef			Reference to the subject type
‎‎ ‎ ‎‎ ‎ └─ id	string			Tariff plan ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Tariff plan reference ID
‎‎ ‎ └─ name	string			Tariff plan name

POSTAccount-to-account transfer

POST /tx/v1/tran/account2account

Performs account-to-account transfer transaction (contract-to-contract in TX)

Request body

{
  "src": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "dst": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "value": {
    "amt": 20,
    "ccy": "USD"
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ src	body	contract-ContractRef	✔	References to the contract
‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ └─ extRid	body	string		Contract external reference ID
└─ dst	body	contract-ContractRef	✔	References to the contract
└─ value	body	common-MonetaryValue	✔	Amount and currency
‎‎ ‎ └─ amt	body	number		Amount
‎‎ ‎ └─ ccy	body	string		Alpha3 currency code
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTCard-to-account transfer

POST /tx/v1/tran/card2account

Performs card-to-account transfer transaction (card-to-contract in TX)

Request body

{
  "src": {
    "pan": 7645346863537866000,
    "expDate": "2027-10-21",
    "cvv2": 222,
    "tds": {
      "version": 2.1,
      "networkType": "string",
      "eci": 5,
      "condition": "string",
      "cavv": 5,
      "dsTranId": 7976543639,
      "xid": "SGVsbG8sIFdvcmxkIQ"
    }
  },
  "dst": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "value": {
    "amt": 20,
    "ccy": "USD"
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ src	body	tran-SrcCard	✔	Source card details
‎‎ ‎ └─ pan	body	string	✔	Card PAN
‎‎ ‎ └─ expDate	body	string(date)	✔	Card expiration date
‎‎ ‎ └─ cvv2	body	string		Card CVV2 value
‎‎ ‎ └─ tds	body	object		e-commerce 3D-Secure details
‎‎ ‎ ‎‎ ‎ └─ version	body	string		3D-Secure (3DS) version, e.g. 1.0, 2.2, etc.
‎‎ ‎ ‎‎ ‎ └─ networkType	body	string		Network type
‎‎ ‎ ‎‎ ‎ └─ eci	body	string		Network related e-commerce indicator
‎‎ ‎ ‎‎ ‎ └─ condition	body	string		3DS authentication conditions
‎‎ ‎ ‎‎ ‎ └─ cavv	body	string		3DS cardholder authentication verification value (CAVV)
‎‎ ‎ ‎‎ ‎ └─ dsTranId	body	string		Transaction ID from Directory Server
‎‎ ‎ ‎‎ ‎ └─ xid	body	string		3DS XID parameter
└─ dst	body	contract-ContractRef	✔	References to the contract
‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ └─ extRid	body	string		Contract external reference ID
└─ value	body	common-MonetaryValue	✔	Amount and currency
‎‎ ‎ └─ amt	body	number		Amount
‎‎ ‎ └─ ccy	body	string		Alpha3 currency code
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTAccount-to-card transfer

POST /tx/v1/tran/account2card

Performs account-to-card transfer transaction (contract-to-card in TX)

Request body

{
  "src": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "dst": {
    "pan": 6645346863537866000,
    "expDate": "2027-10-21"
  },
  "value": {
    "amt": 20,
    "ccy": "USD"
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ src	body	contract-ContractRef	✔	References to the contract
‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ └─ extRid	body	string		Contract external reference ID
└─ dst	body	tran-DstCard	✔	Destination card details
‎‎ ‎ └─ pan	body	string	✔	Card PAN
‎‎ ‎ └─ expDate	body	string(date)		Card expiration date
└─ value	body	common-MonetaryValue	✔	Amount and currency
‎‎ ‎ └─ amt	body	number		Amount
‎‎ ‎ └─ ccy	body	string		Alpha3 currency code
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTCard-to-card transfer

POST /tx/v1/tran/card2card

Performs card-to-card transfer transaction

Request body

{
  "src": {
    "pan": 7645346863537866000,
    "expDate": "2027-10-21",
    "cvv2": 222,
    "tds": {
      "version": 2.1,
      "networkType": "string",
      "eci": 5,
      "condition": "string",
      "cavv": 5,
      "dsTranId": 7976543639,
      "xid": "SGVsbG8sIFdvcmxkIQ"
    }
  },
  "dst": {
    "pan": 6645346863537866000,
    "expDate": "2027-10-21"
  },
  "value": {
    "amt": 20,
    "ccy": "USD"
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ src	body	tran-SrcCard	✔	Source card details
‎‎ ‎ └─ pan	body	string	✔	Card PAN
‎‎ ‎ └─ expDate	body	string(date)	✔	Card expiration date
‎‎ ‎ └─ cvv2	body	string		Card CVV2 value
‎‎ ‎ └─ tds	body	object		e-commerce 3D-Secure details
‎‎ ‎ ‎‎ ‎ └─ version	body	string		3D-Secure (3DS) version, e.g. 1.0, 2.2, etc.
‎‎ ‎ ‎‎ ‎ └─ networkType	body	string		Network type
‎‎ ‎ ‎‎ ‎ └─ eci	body	string		Network related e-commerce indicator
‎‎ ‎ ‎‎ ‎ └─ condition	body	string		3DS authentication conditions
‎‎ ‎ ‎‎ ‎ └─ cavv	body	string		3DS cardholder authentication verification value (CAVV)
‎‎ ‎ ‎‎ ‎ └─ dsTranId	body	string		Transaction ID from Directory Server
‎‎ ‎ ‎‎ ‎ └─ xid	body	string		3DS XID parameter
└─ dst	body	tran-DstCard	✔	Destination card details
‎‎ ‎ └─ pan	body	string	✔	Card PAN
‎‎ ‎ └─ expDate	body	string(date)		Card expiration date
└─ value	body	common-MonetaryValue	✔	Amount and currency
‎‎ ‎ └─ amt	body	number		Amount
‎‎ ‎ └─ ccy	body	string		Alpha3 currency code
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTPerform payment to service provider

POST /tx/v1/tran/account2vendor

Performs payment from customer account to service provider (e.g. utility, bill, etc.)

Request body

{
  "src": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "dst": {
    "rid": "SPRID865439"
  },
  "value": {
    "amt": 20,
    "ccy": "USD"
  },
  "params": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ],
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ src	body	contract-ContractRef	✔	References to the contract
‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ └─ extRid	body	string		Contract external reference ID
└─ dst	body	tran-Vendor	✔	Reference to the service provider (payments)
‎‎ ‎ └─ rid	body	string	✔	Service provider reference ID (payee contract RID)
└─ value	body	common-MonetaryValue	✔	Amount and currency
‎‎ ‎ └─ amt	body	number		Amount
‎‎ ‎ └─ ccy	body	string		Alpha3 currency code
└─ params	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ └─ val	body	string		Value
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTDebit account

POST /tx/v1/tran/account2fi

Performs account debit transaction (contract-to-FI in TX). The destination amount will be credited to Financial Institution (FI) account according to TX configuration.

Request body

{
  "src": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "value": {
    "amt": 20,
    "ccy": "USD"
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ src	body	contract-ContractRef	✔	References to the contract
‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ └─ extRid	body	string		Contract external reference ID
└─ value	body	common-MonetaryValue	✔	Amount and currency
‎‎ ‎ └─ amt	body	number		Amount
‎‎ ‎ └─ ccy	body	string		Alpha3 currency code
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTCredit account

POST /tx/v1/tran/fi2account

Performs account credit transaction (FI-to-contract in TX). The source amount will be debited from Financial Institution (FI) account according to TX configuration.

Request body

{
  "dst": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "value": {
    "amt": 20,
    "ccy": "USD"
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ dst	body	contract-ContractRef	✔	References to the contract
‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ └─ extRid	body	string		Contract external reference ID
└─ value	body	common-MonetaryValue	✔	Amount and currency
‎‎ ‎ └─ amt	body	number		Amount
‎‎ ‎ └─ ccy	body	string		Alpha3 currency code
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTCard purchase (e-commerce)

POST /tx/v1/tran/purchase

Performs e-commerce purchase operation using a card and the terminal as parameters. Usually, this type of transaction is initiated by an acquirer following the request from e-commerce merchant.

Request body

{
  "card": {
    "pan": 7645346863537866000,
    "expDate": "2027-10-21",
    "cvv2": 222,
    "tds": {
      "version": 2.1,
      "networkType": "string",
      "eci": 5,
      "condition": "string",
      "cavv": 5,
      "dsTranId": 7976543639,
      "xid": "SGVsbG8sIFdvcmxkIQ"
    }
  },
  "terminal": {
    "tid": "TID2468",
    "mid": "MID13579"
  },
  "value": {
    "amt": 20,
    "ccy": "USD"
  },
  "lifePhase": "Auth",
  "specific": {
    "installment": {
      "byMerchant": {
        "typeId": 135,
        "trancheCnt": 5,
        "initialAmt": 237
      },
      "byIssuer": {
        "planId": "CRID245",
        "trancheCnt": 6
      }
    }
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ card	body	tran-SrcCard	✔	Source card details
‎‎ ‎ └─ pan	body	string	✔	Card PAN
‎‎ ‎ └─ expDate	body	string(date)	✔	Card expiration date
‎‎ ‎ └─ cvv2	body	string		Card CVV2 value
‎‎ ‎ └─ tds	body	object		e-commerce 3D-Secure details
‎‎ ‎ ‎‎ ‎ └─ version	body	string		3D-Secure (3DS) version, e.g. 1.0, 2.2, etc.
‎‎ ‎ ‎‎ ‎ └─ networkType	body	string		Network type
‎‎ ‎ ‎‎ ‎ └─ eci	body	string		Network related e-commerce indicator
‎‎ ‎ ‎‎ ‎ └─ condition	body	string		3DS authentication conditions
‎‎ ‎ ‎‎ ‎ └─ cavv	body	string		3DS cardholder authentication verification value (CAVV)
‎‎ ‎ ‎‎ ‎ └─ dsTranId	body	string		Transaction ID from Directory Server
‎‎ ‎ ‎‎ ‎ └─ xid	body	string		3DS XID parameter
└─ terminal	body	object	✔	Merchant and terminal details
‎‎ ‎ └─ tid	body	string		Terminal ID. In TX, the value is usually stored in Terminal RID field.
‎‎ ‎ └─ mid	body	string		Merchant ID
└─ value	body	common-MonetaryValue	✔	Amount and currency
‎‎ ‎ └─ amt	body	number		Amount
‎‎ ‎ └─ ccy	body	string		Alpha3 currency code
└─ lifePhase	body	string		Transaction life phase, i.e. Authorization, Presentment, Single
└─ specific	body	object
‎‎ ‎ └─ installment	body	tran-InstallmentRq		Parameters related to installment management request
‎‎ ‎ ‎‎ ‎ └─ byMerchant	body	object		Installment funded by a merchant
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ typeId	body	integer		Installment-related Contract Type ID in TX
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ trancheCnt	body	integer		Number of installments (without the initial payment)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ initialAmt	body	number		Minimum initial payment amount in transaction currency
‎‎ ‎ ‎‎ ‎ └─ byIssuer	body	object		Installment funded by issuer or financial institution
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ planId	body	string		Installment plan ID as installment-related Contract Type RID in TX
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ trancheCnt	body	integer		Number of installments
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "installment": {
    "byMerchant": {
      "tranches": [
        {
          "mainAmt": 237,
          "surchargeAmt": 5
        }
      ]
    },
    "byIssuer": {
      "contractTypeId": 135,
      "trancheCnt": 6,
      "apr": 4,
      "interestRate": 3
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ tranId	integer			Unique transaction ID in the system
└─ approvalCode	string
└─ installment	tran-InstallmentRs			Parameters related to installment management response
‎‎ ‎ └─ byMerchant	object			Installment funded by a merchant
‎‎ ‎ ‎‎ ‎ └─ tranches	[object]			List of installments
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mainAmt	number			Amount in currency in which customer was serviced, as specified in payment transaction
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ surchargeAmt	number			Surcharge amount, if applicable (in currency in which customer was serviced, as specified in payment transaction)
‎‎ ‎ └─ byIssuer	tran-InstallmentRs/properties/byIssuer			Installment funded by issuer or financial institution
‎‎ ‎ ‎‎ ‎ └─ contractTypeId	integer			Installment-related Contract Type ID in TX
‎‎ ‎ ‎‎ ‎ └─ trancheCnt	integer			Number of installments
‎‎ ‎ ‎‎ ‎ └─ apr	number			Annual Percentage Rate
‎‎ ‎ ‎‎ ‎ └─ interestRate	number			Interest rate

POSTIssuer-funded post-purchase installment

POST /tx/v1/tran/{tranId}/installment

Converts the specified transaction into installments

Request body

{
  "contractTypeId": 135,
  "trancheCnt": 6,
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
tranId	path	integer	✔	Transaction ID
body	body	object	✔
└─ contractTypeId	body	integer	✔	Installment-related Contract Type ID in TX
└─ trancheCnt	body	integer	✔	Number of installments
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-ModifyTranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTMerchandise return / refund

POST /tx/v1/tran/refund

Performs card transaction refund

Request body

{
  "card": {
    "pan": 6645346863537866000,
    "expDate": "2027-10-21"
  },
  "terminal": {
    "tid": "string",
    "mid": "string"
  },
  "value": {
    "amt": 20,
    "ccy": "USD"
  },
  "refundedTran": {
    "id": 7875458909934,
    "matchKey": "trnaadgk1357924680",
    "rqSentTime": "2020-10-21T14:15:00"
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ card	body	tran-DstCard	✔	Destination card details
‎‎ ‎ └─ pan	body	string	✔	Card PAN
‎‎ ‎ └─ expDate	body	string(date)		Card expiration date
└─ terminal	body	object	✔	Merchant terminal details
‎‎ ‎ └─ tid	body	string		Terminal ID. In TX, the value is usually stored in Terminal RID field.
‎‎ ‎ └─ mid	body	string		Merchant ID
└─ value	body	common-MonetaryValue	✔	Amount and currency
‎‎ ‎ └─ amt	body	number		Amount
‎‎ ‎ └─ ccy	body	string		Alpha3 currency code
└─ refundedTran	body	tran-TranRef		References to the transaction
‎‎ ‎ └─ id	body	integer		Transaction internal ID
‎‎ ‎ └─ matchKey	body	string		Transaction matching key assigned. Used by TX for transaction matching, and passed in the specific field in the request body - /tranRq/match/key.
‎‎ ‎ └─ rqSentTime	body	string(date-time)		Date and time when the transaction request was sent to the system. The system will match the matchKey and the transaction regTime within the following windowframe - rqSentTime <= regTimeand <= rqSentTime + 60s
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

POSTReverse transaction

POST /tx/v1/tran/reversal

Performs reversal of the transaction

Request body

{
  "reversedTran": {
    "id": 7875458909934,
    "matchKey": "trnaadgk1357924680",
    "rqSentTime": "2020-10-21T14:15:00"
  },
  "reason": "string",
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	✔
└─ reversedTran	body	tran-TranRef	✔	References to the transaction
‎‎ ‎ └─ id	body	integer		Transaction internal ID
‎‎ ‎ └─ matchKey	body	string		Transaction matching key assigned. Used by TX for transaction matching, and passed in the specific field in the request body - /tranRq/match/key.
‎‎ ‎ └─ rqSentTime	body	string(date-time)		Date and time when the transaction request was sent to the system. The system will match the matchKey and the transaction regTime within the following windowframe - rqSentTime <= regTimeand <= rqSentTime + 60s
└─ reason	body	string		Reversal reason
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

GETGet transaction details

GET /tx/v1/tran

Retrieves transaction details by a reference

Parameters

Name	In	Type	Required	Description
ref	query	tran-TranRef	✔	Reference to the transaction

Example responses

200 Response

{
  "id": 799265548903,
  "regTime": "2020-10-21T14:15:00",
  "operDay": "2020-10-21",
  "lifePhase": "string",
  "kind": "Goods",
  "isReversal": false,
  "network": {
    "id": 3,
    "code": "ID3",
    "type": "string"
  },
  "src": {
    "card": {
      "panMask": "764534*******6533",
      "expDate": "2027-10-21"
    },
    "contract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    }
  },
  "dst": {
    "card": {
      "panMask": "664534*******6533",
      "expDate": "2028-10-21"
    },
    "contract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    },
    "vendor": {
      "rid": "SPRID865439"
    }
  },
  "terminal": {
    "name": "TPOS763583",
    "type": "Ecom",
    "countryCode": 840,
    "owner": {
      "mcc": 5992
    }
  },
  "values": {
    "customer": {
      "amt": 20.54,
      "ccy": "USD"
    },
    "clearing": {
      "amt": 20.54,
      "ccy": "USD"
    }
  },
  "result": "Approved",
  "details": {
    "rtpRequest": "string",
    "rtpResponse": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	tran
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

GETList card or account transactions

GET /tx/v1/trans

Gets the list of transactions for a card or an account (contract). This endpoint supports filtering, sorting and pagination.

Parameters

Name	In	Type	Required	Description
card	query	card-CardRef		Reference to the card
contract	query	contract-ContractRef		Reference to the contract
filter	query	TransFilter		Filtering criteria. Refer to Filtering chapter to get more details on parameter usage.
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.
order	query	TransOrder		Sorting parameters. Refer to Sorting chapter to get more details on parameter usage.

order ─ Enumerated Value

Value
IdAsc
IdDesc

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "id": 799265548903,
      "regTime": "2020-10-21T14:15:00",
      "operDay": "2020-10-21",
      "lifePhase": "string",
      "kind": "Goods",
      "isReversal": false,
      "network": {
        "id": 3,
        "code": "ID3",
        "type": "string"
      },
      "src": {
        "card": {
          "panMask": "764534*******6533",
          "expDate": "2027-10-21"
        },
        "contract": {
          "id": 4680,
          "rid": "CRID4542809",
          "extRid": "CASA1268"
        }
      },
      "dst": {
        "card": {
          "panMask": "664534*******6533",
          "expDate": "2028-10-21"
        },
        "contract": {
          "id": 4680,
          "rid": "CRID4542809",
          "extRid": "CASA1268"
        },
        "vendor": {
          "rid": "SPRID865439"
        }
      },
      "terminal": {
        "name": "TPOS763583",
        "type": "Ecom",
        "countryCode": 840,
        "owner": {
          "mcc": 5992
        }
      },
      "values": {
        "customer": {
          "amt": 20.54,
          "ccy": "USD"
        },
        "clearing": {
          "amt": 20.54,
          "ccy": "USD"
        }
      },
      "result": "Approved",
      "details": {
        "rtpRequest": "string",
        "rtpResponse": "string"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[tran]			Contains the returned еransactions (without the details)
‎‎ ‎ └─ id	string			Transaction unique ID
‎‎ ‎ └─ regTime	string(date-time)			Transaction registration system date and time
‎‎ ‎ └─ operDay	string(date)			Transaction processing business date
‎‎ ‎ └─ lifePhase	string			Transaction life phase. Life phase represents different states of the transaction e.g. authorization, presentment, chargeback, etc.
‎‎ ‎ └─ kind	string			Transaction type, e.g. purchase, payment, deposit, etc. There are many transaction kinds (types) in TX, not all of them may be relevant to your project. Please check with the project team what kinds are applicable.
‎‎ ‎ └─ isReversal	boolean			Indicates if the transaction is the reversal. A value of true indicates that the transaction is the reversal transaction.
‎‎ ‎ └─ network	object			Details regarding the payment network, if the transaction processed through the network
‎‎ ‎ ‎‎ ‎ └─ id	integer			Network internal ID
‎‎ ‎ ‎‎ ‎ └─ code	string			Network reference code
‎‎ ‎ ‎‎ ‎ └─ type	string			Network type
‎‎ ‎ └─ src	object			Payment source (card or account/contract)
‎‎ ‎ ‎‎ ‎ └─ card	object			Source card details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ panMask	string			Card PAN (masked)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ expDate	string(date)			Card expiration date
‎‎ ‎ ‎‎ ‎ └─ contract	contract-ContractRef			References to the contract
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ id	integer			Contract internal ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string			Contract reference ID
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ extRid	string			Contract external reference ID
‎‎ ‎ └─ dst	object			Payment destination (card / account / vendor)
‎‎ ‎ ‎‎ ‎ └─ card	object			Destination card details
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ panMask	string			Card PAN (masked)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ expDate	string(date)			Card expiration date
‎‎ ‎ ‎‎ ‎ └─ contract	contract-ContractRef			References to the contract
‎‎ ‎ ‎‎ ‎ └─ vendor	tran-Vendor			Reference to the service provider (payments)
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ rid	string	✔		Service provider reference ID (payee contract RID)
‎‎ ‎ └─ terminal	object			Terminal details
‎‎ ‎ ‎‎ ‎ └─ name	string			Terminal name
‎‎ ‎ ‎‎ ‎ └─ type	string			Terminal type
‎‎ ‎ ‎‎ ‎ └─ countryCode	integer			Terminal country (ISO 3-digits country code)
‎‎ ‎ ‎‎ ‎ └─ owner	object
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ mcc	integer			Merchant category code, e.g. as used in merchant acquiring (4-digits ISO MCC for retail financial services)
‎‎ ‎ └─ values	object			Transaction amounts
‎‎ ‎ ‎‎ ‎ └─ customer	object			Customer billing amount
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ amt	number			Transaction billing amount
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ ccy	string			Transaction billing currency (alpha3 currency code)
‎‎ ‎ ‎‎ ‎ └─ clearing	object			Clearing amount
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ amt	number			Transaction clearing amount
‎‎ ‎ ‎‎ ‎ ‎‎ ‎ └─ ccy	string			Transaction clearing currency (alpha3 currency code)
‎‎ ‎ └─ result	string			Transaction processing result in TX
‎‎ ‎ └─ details	object			Transaction additional information, returned for GET Tran operation only. This is the TX native transaction representation as stored inside TX in TX RTP format.
‎‎ ‎ ‎‎ ‎ └─ rtpRequest	string			TX RTP request details (XML)
‎‎ ‎ ‎‎ ‎ └─ rtpResponse	string			TX RTP response details (XML)

GETList of available installment plans

GET /tx/v1/tran/{tranId}/installment/plans

Returns the list of available installment plans (contract type IDs) for a transaction, e.g. for issuer-funded post-purchase installment

Parameters

Name	In	Type	Required	Description
tranId	path	integer	✔	Transaction ID to be converted to installments

Example responses

200 Response

{
  "plans": [
    {
      "contractTypeId": 135,
      "trancheCnt": 6,
      "apr": 4,
      "interestRate": 3
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ plans	[tran-InstallmentRs/properties/byIssuer]			Installment plans available
‎‎ ‎ └─ contractTypeId	integer			Installment-related Contract Type ID in TX
‎‎ ‎ └─ trancheCnt	integer			Number of installments
‎‎ ‎ └─ apr	number			Annual Percentage Rate
‎‎ ‎ └─ interestRate	number			Interest rate

Applications

GETGet application

GET /tx/v1/application

Retrieves application details

Parameters

Name	In	Type	Required	Description
ref	query	application-ApplicationRef	✔	Unique reference to the application

Example responses

200 Response

{
  "ref": {
    "id": 13579,
    "rid": "ARID24680",
    "key": "aadgk1357924680"
  },
  "customer": {
    "id": 1746,
    "rid": "PRID73"
  },
  "contract": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "card": {
    "id": 13579,
    "rid": "CRDRID24680"
  },
  "type": {
    "id": 12,
    "rid": "ATRID12"
  },
  "status": "string",
  "prevStatus": "string",
  "name": "Sample application 1",
  "comments": "This is a test application",
  "times": {
    "creation": "2020-10-21T14:15:00",
    "finish": "2022-10-21T14:15:00"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	application
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
500	Internal Server Error	Internal server error

PUTCreate or update application

PUT /tx/v1/application

Creates new or updates an existing application

Request body

{
  "object": {
    "ref": {
      "id": 13579,
      "rid": "ARID24680",
      "key": "aadgk1357924680"
    },
    "customer": {
      "id": 1746,
      "rid": "PRID73"
    },
    "contract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    },
    "card": {
      "id": 13579,
      "rid": "CRDRID24680"
    },
    "type": {
      "id": 12,
      "rid": "ATRID12"
    },
    "status": "string",
    "prevStatus": "string",
    "name": "Sample application 1",
    "comments": "This is a test application",
    "times": {
      "creation": "2020-10-21T14:15:00",
      "finish": "2022-10-21T14:15:00"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  },
  "tranRq": {
    "clerkName": "Operator_1",
    "intMess": 7,
    "textMess": "TTY=8872;SHIF-6839;",
    "categoryCode": "TCC3",
    "categoryText": "Unhandled",
    "classification": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ],
    "match": {
      "key": "adgjl1357guid",
      "rrn": "RN6538303344"
    },
    "userAttrs": [
      {
        "rid": "UDPRID3",
        "val": "VAL-1"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
mustExist	query	boolean		Object presence control. Refer to Idempotency chapter to get more details on parameter usage.
body	body	object
└─ object	body	application		Application object. Applications can be linked with customer, account (contract) or card.
‎‎ ‎ └─ ref	body	application-ApplicationRef		Unique references to the application
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Application internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Application reference ID
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Application additional unique key that can be used to quickly search the application
‎‎ ‎ └─ customer	body	subject-SubjectRef		References to the person/company
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ └─ contract	body	contract-ContractRef		References to the contract
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Contract internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Contract reference ID
‎‎ ‎ ‎‎ ‎ └─ extRid	body	string		Contract external reference ID
‎‎ ‎ └─ card	body	card-CardRef		References to the card
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Card internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Card reference ID
‎‎ ‎ └─ type	body	application-type-ApplicationTypeRef		Unique references to the application type
‎‎ ‎ ‎‎ ‎ └─ id	body	integer		Application type internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Application type reference ID
‎‎ ‎ └─ status	body	string		Application status
‎‎ ‎ └─ prevStatus	body	string		Application previous status
‎‎ ‎ └─ name	body	string		Application name
‎‎ ‎ └─ comments	body	string		Comments attached to the application
‎‎ ‎ └─ times	body	object
‎‎ ‎ ‎‎ ‎ └─ creation	body	string(date-time)		Application creation date and time
‎‎ ‎ ‎‎ ‎ └─ finish	body	string(date-time)		The date and time when the application was finally processed
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	body	string		Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	body	string		Value
└─ tranRq	body	common-TranRqExtraAttrs		Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)
‎‎ ‎ └─ clerkName	body	string		Operator name
‎‎ ‎ └─ intMess	body	integer		Message ID
‎‎ ‎ └─ textMess	body	string		Text message container
‎‎ ‎ └─ categoryCode	body	string		Transaction category code
‎‎ ‎ └─ categoryText	body	string		Transaction category name
‎‎ ‎ └─ classification	body	[common-UserAttr]		Container of user-defined attributes
‎‎ ‎ └─ match	body	common-TranMatch		Transactions matching properties
‎‎ ‎ ‎‎ ‎ └─ key	body	string		Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
‎‎ ‎ ‎‎ ‎ └─ rrn	body	string		Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.
‎‎ ‎ └─ userAttrs	body	[common-UserAttr]		Container of user-defined attributes

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-ModifyTranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

DELETEDelete application

DELETE /tx/v1/application

Deletes existing application

Parameters

Name	In	Type	Required	Description
ref	query	application-ApplicationRef	✔	Unique reference to the application

Example responses

200 Response

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Responses

Status	Meaning	Description	Schema
200	OK	Transaction approved	common-TranApproveRs
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
404	Not Found	Not found
422	Unprocessable Entity	Transaction declined	common-TranDeclineRs
500	Internal Server Error	Internal server error

GETList applications

GET /tx/v1/applications

Gets the list of applications for a customer. This endpoint supports filtering, sorting and pagination.

Parameters

Name	In	Type	Required	Description
subject	query	subject-SubjectRef	✔	Unique reference to the customer
filter	query	ApplicationsFilter		Filtering criteria. Refer to Filtering chapter to get more details on parameter usage.
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.
order	query	ApplicationsOrder		Sorting parameters. Refer to Sorting chapter to get more details on parameter usage.

order ─ Enumerated Value

Value
IdAsc
IdDesc

Example responses

200 Response

{
  "hasMore": true,
  "objects": [
    {
      "ref": {
        "id": 13579,
        "rid": "ARID24680",
        "key": "aadgk1357924680"
      },
      "customer": {
        "id": 1746,
        "rid": "PRID73"
      },
      "contract": {
        "id": 4680,
        "rid": "CRID4542809",
        "extRid": "CASA1268"
      },
      "card": {
        "id": 13579,
        "rid": "CRDRID24680"
      },
      "type": {
        "id": 12,
        "rid": "ATRID12"
      },
      "status": "string",
      "prevStatus": "string",
      "name": "Sample application 1",
      "comments": "This is a test application",
      "times": {
        "creation": "2020-10-21T14:15:00",
        "finish": "2022-10-21T14:15:00"
      },
      "userAttrs": [
        {
          "rid": "UDPRID3",
          "val": "VAL-1"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad request
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal server error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[application]			Contains the returned applications.
‎‎ ‎ └─ ref	application-ApplicationRef			Unique references to the application
‎‎ ‎ ‎‎ ‎ └─ id	integer			Application internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Application reference ID
‎‎ ‎ ‎‎ ‎ └─ key	string			Application additional unique key that can be used to quickly search the application
‎‎ ‎ └─ customer	subject-SubjectRef			References to the person/company
‎‎ ‎ ‎‎ ‎ └─ id	integer			Internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ └─ contract	contract-ContractRef			References to the contract
‎‎ ‎ ‎‎ ‎ └─ id	integer			Contract internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Contract reference ID
‎‎ ‎ ‎‎ ‎ └─ extRid	string			Contract external reference ID
‎‎ ‎ └─ card	card-CardRef			References to the card
‎‎ ‎ ‎‎ ‎ └─ id	integer			Card internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Card reference ID
‎‎ ‎ └─ type	application-type-ApplicationTypeRef			Unique references to the application type
‎‎ ‎ ‎‎ ‎ └─ id	integer			Application type internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Application type reference ID
‎‎ ‎ └─ status	string			Application status
‎‎ ‎ └─ prevStatus	string			Application previous status
‎‎ ‎ └─ name	string			Application name
‎‎ ‎ └─ comments	string			Comments attached to the application
‎‎ ‎ └─ times	object
‎‎ ‎ ‎‎ ‎ └─ creation	string(date-time)			Application creation date and time
‎‎ ‎ ‎‎ ‎ └─ finish	string(date-time)			The date and time when the application was finally processed
‎‎ ‎ └─ userAttrs	[common-UserAttr]			Container of user-defined attributes
‎‎ ‎ ‎‎ ‎ └─ rid	string			Reference ID
‎‎ ‎ ‎‎ ‎ └─ val	string			Value

GETList application types

GET /tx/v1/application-types

List application types available. This endpoint supports pagination.

Parameters

Name	In	Type	Required	Description
page	query	Pagination		Pagination parameters. Refer to Pagination chapter to get more details on parameter usage.

Example responses

200 Response

{
  "hasMore": false,
  "objects": [
    {
      "ref": {
        "id": 12,
        "rid": "ATRID12"
      },
      "name": "Credit applications",
      "isAbstract": false,
      "parentType": {
        "id": 11,
        "rid": "ATRID11"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized
403	Forbidden	Forbidden
500	Internal Server Error	Internal Server Error

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
└─ hasMore	boolean			Indicates if more objects can be fetched. A value of true indicates that more unreturned objects exist.
└─ objects	[application-type]			Contains the returned application types.
‎‎ ‎ └─ ref	application-type-ApplicationTypeRef			Unique references to the application type
‎‎ ‎ ‎‎ ‎ └─ id	integer			Application type internal ID
‎‎ ‎ ‎‎ ‎ └─ rid	string			Application type reference ID
‎‎ ‎ └─ name	string			Application type name
‎‎ ‎ └─ isAbstract	boolean			Indicates if the application type can be used to create applications of that type. A value of true indicates that the application type is abstract and is only used to build a hierarchy of application types.
‎‎ ‎ └─ parentType	application-type-ApplicationTypeRef			Unique references to the application type

Schemas

ApplicationsFilter

{
  "applicationTypeId": 12,
  "applicationTypeRid": "ATRID12",
  "status": "string"
}

Properties

Name	Type	Required	Restrictions	Description
applicationTypeId	integer			Application type ID
applicationTypeRid	string			Application type reference ID
status	string			Application status

ApplicationsOrder

"IdAsc"

Field on which to sort (in ascending or descending order) - application ID.

Properties

Name	Type	Required	Restrictions	Description
	string			Field on which to sort (in ascending or descending order) - application ID.

Enumerated Values

Property	Value
	IdAsc
	IdDesc

CardsFilter

{
  "holderId": 23579,
  "holderRid": "CH56357",
  "status": "string"
}

Either holderId or holderRid is required

Properties

Name	Type	Required	Restrictions	Description
holderId	integer			Cardholder internal ID
holderRid	string			Cardholder reference ID
status	string			Card status

CardsOrder

"IdAsc"

Field on which to sort (in ascending, descending order) - card ID

Properties

Name	Type	Required	Restrictions	Description
	string			Field on which to sort (in ascending, descending order) - card ID

Enumerated Values

Property	Value
	IdAsc
	IdDesc

CountersToReset

{
  "invalidCvv2TriesCnt": true,
  "invalidIPinTriesCnt": true,
  "invalidPinTriesCnt": true,
  "invalidTdsEnrollTriesCnt": true,
  "invalidPersonAnswerTriesCnt": true,
  "invalidCallbackTriesCnt": true,
  "invalidPasswordTriesCnt": true
}

Properties

Name	Type	Required	Restrictions	Description
invalidCvv2TriesCnt	boolean			Number of incorrect CVV2 attempts
invalidIPinTriesCnt	boolean			Number of incorrect IPIN attempts
invalidPinTriesCnt	boolean			Number of incorrect PIN attempts
invalidTdsEnrollTriesCnt	boolean			Number of unsuccessful 3-D Secure enrollment authentication attempts
invalidPersonAnswerTriesCnt	boolean			Number of incorrect answers to authentication question
invalidCallbackTriesCnt	boolean			Number of incorrect one-time password attempts
invalidPasswordTriesCnt	boolean			Number of incorrect password attempts

Pagination

{
  "offset": 0,
  "limit": 100
}

Pagination parameters

Properties

Name	Type	Required	Restrictions	Description
offset	integer			Page start offset (>=0)
limit	integer			Page length

ContractsFilter

{
  "clientId": 3579,
  "clientRid": "CSTRID765739",
  "typeId": 865,
  "typeRid": "CNTTRID4689",
  "status": "string"
}

One of clientId or clientRid is required

Properties

Name	Type	Required	Restrictions	Description
clientId	integer			Customer internal ID
clientRid	string			Customer reference ID
typeId	integer			Contract type internal ID
typeRid	string			Contract type reference ID
status	string			Contract status

ContractsOrder

"IdAsc"

Field on which to sort (in ascending, descending order) - contract ID

Properties

Name	Type	Required	Restrictions	Description
	string			Field on which to sort (in ascending, descending order) - contract ID

Enumerated Values

Property	Value
	IdAsc
	IdDesc

Contract2ContractsFilter

{
  "contract1Id": 0,
  "contract1Rid": "string",
  "contract2Id": 0,
  "contract2Rid": "string",
  "kind": "string",
  "status": "string"
}

Properties

Name	Type	Required	Restrictions	Description
contract1Id	integer			The first contract ID
contract1Rid	string			The first contract reference ID
contract2Id	integer			The second contract ID
contract2Rid	string			The second contract reference ID
kind	string			Type of the link
status	string			Link status

Contract2ContractsOrder

"IdAsc"

Field on which to sort (in ascending, descending order) - Link ID, Link sequence number

Properties

Name	Type	Required	Restrictions	Description
	string			Field on which to sort (in ascending, descending order) - Link ID, Link sequence number

Enumerated Values

Property	Value
	IdAsc
	IdDesc
	SeqAsc
	SeqDesc

SubjectsFilter

{
  "kind": "Person",
  "firstNameLike": "john%",
  "lastNameLike": "do%",
  "birthDate": "2000-10-21",
  "nameLike": "com%",
  "parentId": 8267,
  "parentRid": "PCRID0735"
}

Properties

Name	Type	Required	Restrictions	Description
kind	subject-SubjectKind	✔		Kind of the subject
firstNameLike	string			Partial string matching the person's first name (applicable for "person" only). The search is not case-sensitive, wildcards supported - the percent sign (%) to substitute a group of characters, and the underscore (_) to substitute one character)
lastNameLike	string			Partial string matching the person's last name (applicable for "person" only). The search is not case-sensitive, wildcards supported - the percent sign (%) to substitute a group of characters, and the underscore (_) to substitute one character)
birthDate	string(date)			Person's birth date (applicable for "person" only)
nameLike	string			Partial string matching the company name (applicable for "company" only). The search is not case-sensitive, wildcards supported - the percent sign (%) to substitute a group of characters, and the underscore (_) to substitute one character)
parentId	integer			Parent company ID (applicable for "company" only)
parentRid	string			Parent company reference ID (applicable for "company" only)

SubjectsOrder

"IdAsc"

Field on which to sort (in ascending, descending order) - ID, Reference ID, Name (person last name, person first name; company name)

Properties

Name	Type	Required	Restrictions	Description
	string			Field on which to sort (in ascending, descending order) - ID, Reference ID, Name (person last name, person first name; company name)

Enumerated Values

Property	Value
	IdAsc
	IdDesc
	RidAsc
	RidDesc
	NameAsc
	NameDesc

SubjectDocumentsFilter

{
  "subjectId": 7393,
  "subjectRid": "SRID73"
}

One of subjectId or subjectRid is required

Properties

Name	Type	Required	Restrictions	Description
subjectId	integer			Person/company internal ID
subjectRid	string			Person/company reference ID

SubjectDocumentsOrder

"IdAsc"

Field on which to sort (in ascending, descending order) - document ID

Properties

Name	Type	Required	Restrictions	Description
	string			Field on which to sort (in ascending, descending order) - document ID

Enumerated Values

Property	Value
	IdAsc
	IdDesc

TransFilter

{
  "begTime": "2020-10-21T00:00:00",
  "endTime": "2020-10-22T14:15:00"
}

Properties

Name	Type	Required	Restrictions	Description
begTime	string(date-time)			Transaction date, from
endTime	string(date-time)			Transaction date, to

TransOrder

"IdAsc"

Field on which to sort (in ascending, descending order) - transaction ID

Properties

Name	Type	Required	Restrictions	Description
	string			Field on which to sort (in ascending, descending order) - transaction ID

Enumerated Values

Property	Value
	IdAsc
	IdDesc

subject-NetworkSpecAttr

{
  "networkName": "string",
  "toDelete": true,
  "rid": "string",
  "merchantRid": "string",
  "singleMerchantRid": "string",
  "name": "string",
  "mcc": "string"
}

Network-specific attribute

Properties

Name	Type	Required	Restrictions	Description
networkName	string			Network name
toDelete	boolean			Delete this attribute
rid	string			Reference ID
merchantRid	string			Merchant reference ID
singleMerchantRid	string			Single merchant reference ID
name	string			Name
mcc	string			MCC

notification-type-NotificationTypeRef

{
  "id": 87648,
  "rid": "NTRID878"
}

References to the notification type

Properties

Name	Type	Required	Restrictions	Description
id	integer			Notification type ID
rid	string			Notification type reference ID

restriction-OwnerRef

{
  "ownerType": "Contract",
  "ownerId": 4756
}

Reference to the restriction's owner (the object that the restriction is applied to)

Properties

Name	Type	Required	Restrictions	Description
ownerType	string			Restriction owner type
ownerId	integer			Owner ID (primary key)

Enumerated Values

Property	Value
ownerType	Contract
ownerType	Terminal
ownerType	Token
ownerType	Subject

subject-type-SubjectTypeRef

{
  "id": 564,
  "rid": "STRID23"
}

Reference to the subject type

Properties

Name	Type	Required	Restrictions	Description
id	integer			Subject type ID
rid	string			Subject type reference ID

application

{
  "ref": {
    "id": 13579,
    "rid": "ARID24680",
    "key": "aadgk1357924680"
  },
  "customer": {
    "id": 1746,
    "rid": "PRID73"
  },
  "contract": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "card": {
    "id": 13579,
    "rid": "CRDRID24680"
  },
  "type": {
    "id": 12,
    "rid": "ATRID12"
  },
  "status": "string",
  "prevStatus": "string",
  "name": "Sample application 1",
  "comments": "This is a test application",
  "times": {
    "creation": "2020-10-21T14:15:00",
    "finish": "2022-10-21T14:15:00"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Application object. Applications can be linked with customer, account (contract) or card.

Properties

Name	Type	Required	Restrictions	Description
ref	application-ApplicationRef			Unique references to the application
customer	subject-SubjectRef			References to the person/company
contract	contract-ContractRef			References to the contract
card	card-CardRef			References to the card
type	application-type-ApplicationTypeRef			Unique references to the application type
status	string			Application status
prevStatus	string			Application previous status
name	string			Application name
comments	string			Comments attached to the application
times	object
└─ creation	string(date-time)			Application creation date and time
└─ finish	string(date-time)			The date and time when the application was finally processed
userAttrs	common-UserAttrs			Application data presented as a set of attributes

tran

{
  "id": 799265548903,
  "regTime": "2020-10-21T14:15:00",
  "operDay": "2020-10-21",
  "lifePhase": "string",
  "kind": "Goods",
  "isReversal": false,
  "network": {
    "id": 3,
    "code": "ID3",
    "type": "string"
  },
  "src": {
    "card": {
      "panMask": "764534*******6533",
      "expDate": "2027-10-21"
    },
    "contract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    }
  },
  "dst": {
    "card": {
      "panMask": "664534*******6533",
      "expDate": "2028-10-21"
    },
    "contract": {
      "id": 4680,
      "rid": "CRID4542809",
      "extRid": "CASA1268"
    },
    "vendor": {
      "rid": "SPRID865439"
    }
  },
  "terminal": {
    "name": "TPOS763583",
    "type": "Ecom",
    "countryCode": 840,
    "owner": {
      "mcc": 5992
    }
  },
  "values": {
    "customer": {
      "amt": 20.54,
      "ccy": "USD"
    },
    "clearing": {
      "amt": 20.54,
      "ccy": "USD"
    }
  },
  "result": "Approved",
  "details": {
    "rtpRequest": "string",
    "rtpResponse": "string"
  }
}

Transaction object. "Transaction" represents any operation in TX processed by the system (includes both financial and non-financial operations).

Properties

Name	Type	Required	Restrictions	Description
id	string			Transaction unique ID
regTime	string(date-time)			Transaction registration system date and time
operDay	string(date)			Transaction processing business date
lifePhase	string			Transaction life phase. Life phase represents different states of the transaction e.g. authorization, presentment, chargeback, etc.
kind	string			Transaction type, e.g. purchase, payment, deposit, etc. There are many transaction kinds (types) in TX, not all of them may be relevant to your project. Please check with the project team what kinds are applicable.
isReversal	boolean			Indicates if the transaction is the reversal. A value of true indicates that the transaction is the reversal transaction.
network	object			Details regarding the payment network, if the transaction processed through the network
└─ id	integer			Network internal ID
└─ code	string			Network reference code
└─ type	string			Network type
src	object			Payment source (card or account/contract)
└─ card	object			Source card details
‎‎ ‎ └─ panMask	string			Card PAN (masked)
‎‎ ‎ └─ expDate	string(date)			Card expiration date
└─ contract	contract-ContractRef			Source account (contract) details
dst	object			Payment destination (card / account / vendor)
└─ card	object			Destination card details
‎‎ ‎ └─ panMask	string			Card PAN (masked)
‎‎ ‎ └─ expDate	string(date)			Card expiration date
└─ contract	contract-ContractRef			Destination account (contract) details
└─ vendor	tran-Vendor			Service provider details
terminal	object			Terminal details
└─ name	string			Terminal name
└─ type	string			Terminal type
└─ countryCode	integer			Terminal country (ISO 3-digits country code)
└─ owner	object
‎‎ ‎ └─ mcc	integer			Merchant category code, e.g. as used in merchant acquiring (4-digits ISO MCC for retail financial services)
values	object			Transaction amounts
└─ customer	object			Customer billing amount
‎‎ ‎ └─ amt	number			Transaction billing amount
‎‎ ‎ └─ ccy	string			Transaction billing currency (alpha3 currency code)
└─ clearing	object			Clearing amount
‎‎ ‎ └─ amt	number			Transaction clearing amount
‎‎ ‎ └─ ccy	string			Transaction clearing currency (alpha3 currency code)
result	string			Transaction processing result in TX
details	object			Transaction additional information, returned for GET Tran operation only. This is the TX native transaction representation as stored inside TX in TX RTP format.
└─ rtpRequest	string			TX RTP request details (XML)
└─ rtpResponse	string			TX RTP response details (XML)

tran-DstCard

{
  "pan": 6645346863537866000,
  "expDate": "2027-10-21"
}

Destination card details

Properties

Name	Type	Required	Restrictions	Description
pan	string	✔		Card PAN
expDate	string(date)			Card expiration date

subject-auth_qa

{
  "question": "First pet name",
  "answer": "Rocket"
}

Personal authentication question and answer (security questions)

Properties

Name	Type	Required	Restrictions	Description
question	string			Personal authentication question
answer	string			Personal authentication answer

tran-InstallmentRs

{
  "byMerchant": {
    "tranches": [
      {
        "mainAmt": 237,
        "surchargeAmt": 5
      }
    ]
  },
  "byIssuer": {
    "contractTypeId": 135,
    "trancheCnt": 6,
    "apr": 4,
    "interestRate": 3
  }
}

Parameters related to installment management response

Properties

Name	Type	Required	Restrictions	Description
byMerchant	object			Installment funded by a merchant
└─ tranches	[object]			List of installments
‎‎ ‎ └─ mainAmt	number			Amount in currency in which customer was serviced, as specified in payment transaction
‎‎ ‎ └─ surchargeAmt	number			Surcharge amount, if applicable (in currency in which customer was serviced, as specified in payment transaction)
byIssuer	object			Installment funded by issuer or financial institution
└─ contractTypeId	integer			Installment-related Contract Type ID in TX
└─ trancheCnt	integer			Number of installments
└─ apr	number			Annual Percentage Rate
└─ interestRate	number			Interest rate

subject-SubjectRef

{
  "id": 1746,
  "rid": "PRID73"
}

References to the person/company

Properties

Name	Type	Required	Restrictions	Description
id	integer			Internal ID
rid	string			Reference ID

common-TranApproveRs

{
  "tranId": 1357924680,
  "approvalCode": "A200567"
}

Response for approved transaction

Properties

Name	Type	Required	Restrictions	Description
tranId	integer			Unique transaction ID in the system
approvalCode	string

subject-document

{
  "ref": {
    "id": 8737
  },
  "type": {
    "id": 56,
    "rid": "DTRID084"
  },
  "series": 7522,
  "rid": 888122,
  "issuerName": "Regional security office",
  "isActive": true,
  "issueDate": "2020-10-21",
  "expDate": "2035-10-21",
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Document object (passport, national ID, etc.)

Properties

Name	Type	Required	Restrictions	Description
ref	subject-document-SubjectDocumentRef			Reference to the document
type	subject-document-type-SubjectDocumentTypeRef			Reference to the document type
series	string			Document series or prefix. For example, some passports can contain two parts in its number – the series and the number itself, e.g. "7500 123456" as the full passport number.
rid	string			Document number (reference ID)
issuerName	string			Entity that issued the document
isActive	boolean			Indicates if the document is active or not. A value of true indicates that the document is active in TX.
issueDate	string(date)			The date the document was issued
expDate	string(date)			Document expiration date
userAttrs	common-UserAttrs			User-defined attributes

card

{
  "ref": {
    "id": 13579,
    "rid": "CRDRID24680"
  },
  "className": "Smart cards",
  "holder": {
    "id": 1746,
    "rid": "PRID73"
  },
  "issuingContractType": {
    "id": 97548,
    "rid": "CTRID975"
  },
  "issuingContract": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "financialContract": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "mainCard": {
    "id": 13579,
    "rid": "CRDRID24680"
  },
  "product": {
    "id": 22,
    "rid": "CPRID22"
  },
  "design": {
    "id": 12,
    "rid": "DESRID12"
  },
  "panMask": "777777******6543",
  "mbr": 0,
  "status": "string",
  "lifePhaseRid": "LCRID_ATBRANCH",
  "restrictionsProfile": {
    "id": 6846,
    "rid": "RPRID78"
  },
  "tdsEnrollment": true,
  "logistics": {
    "deliveryBranchName": "Branch 1",
    "deliveryAddress": {
      "zip": "NG71AE",
      "country": 0,
      "region": "CAL",
      "regionRid": "string",
      "area": "Nord",
      "areaRid": "string",
      "city": "Homeburg",
      "cityRid": "string",
      "street": "Broadway",
      "streetRid": "string",
      "house": 15,
      "building": 2,
      "construction": 1,
      "flat": 4,
      "addressInCity": null,
      "addressInCountry": null,
      "recipientName": "Robert Smith",
      "phone": 976356838473,
      "fax": null,
      "mobile": 976356838473,
      "email": "r.smith@mymail.net",
      "url": null
    },
    "curBranchName": "Central office"
  },
  "names": {
    "emboss": "Smith",
    "track": "Smith",
    "print": "Smith"
  },
  "dates": {
    "validFrom": "2019-08-24",
    "creation": "2019-08-24",
    "activation": "2019-08-24",
    "expiration": "2019-08-24",
    "closure": "2019-08-24"
  },
  "notes": "Test card",
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Card object

Properties

Name	Type	Required	Restrictions	Description
ref	card-CardRef			References to the card
className	string			General type of the card used for card production, e.g. "Visa Smart Debit/Credit", "MChip Advance", "JCB J/Smart", etc. These classes are predefined in the system and applied during the card product setup in TX. Refer to the TX documentation for a complete list of classes supported.
holder	subject-SubjectRef			Reference to the cardholder (customer)
issuingContractType	contract-type-ContractTypeRef			Reference to the "issuing contract type" object in TX. Also refer to issuingContract element.
issuingContract	contract-ContractRef			Reference to the "issuing contract" object in TX. All cards in TX are created under a special object called "issuing contract", which usually describes common features of card production and usage. "Issuing contract" object belongs to a customer. Several cards can be created under the same issuing contract or each card can have its own issuing contract. Either issuingContract or issuingContractType value must be defined to create a new card, refer to your TX configuration to obtain the correct value for the issuingContractType element. Also refer to /contract endpoint for more details.
financialContract	contract-ContractRef			Reference to the "financial contract" object. Financial contract in TX represents the financial account(s) linked to the card. This property is used when the card is linked to one account only (the most usual case), otherwise use "contract2contract" linkage scheme instead. Also refer to /contract and /contract2contract endpoints for more details.
mainCard	card-CardRef			Reference to the main card, if the card is supplementary
product	card-product-CardProductRef			Reference to card product
design	card-design-CardDesignRef			Reference to card design
panMask	string			Masked PAN
mbr	integer			Card member number / EMV application PAN sequence number
status	string			Card status
lifePhaseRid	string			Card lifecycle phase reference ID. Card lifecycle phases are configured in the system, refer to the TX setup to obtain the list of lifecycle phase IDs configured.
restrictionsProfile	restriction-RestrictionProfileRef			References to the restriction profile
tdsEnrollment	boolean			Indicates if the card is enrolled to e-commerce 3DS service
logistics	object			Card delivery details
└─ deliveryBranchName	string			The branch name where card will be delivered to, in case if the card should be delivered to the branch
└─ deliveryAddress	common-Address			Location address where the card will be delivered to, in case if the card should be delivered to the particular location
└─ curBranchName	string			The branch name where the card currently is
names	object			Names on the card
└─ emboss	string			Name to be printed/embossed on the card
└─ track	string			Name to be written on the Track2 or chip
└─ print	string			Name to be printed on other media, e.g. PIN mailer, etc.
dates	object
└─ validFrom	string(date)			The date the card is valid from
└─ creation	string(date)			Card creation date
└─ activation	string(date)			Card activation date
└─ expiration	string(date)	✔		Card expiration date. This is the full date value, please convert to short format as required, e.g. usually the card expiration date is presented to customers as MM/YY.
└─ closure	string(date)			Card closure date
notes	string			Notes attached to the card
userAttrs	common-UserAttrs			Card user-defined attributes

restriction-RestrictionProfileRef

{
  "id": 6846,
  "rid": "RPRID78"
}

References to the restriction profile

Properties

Name	Type	Required	Restrictions	Description
id	integer			Restriction profile internal ID
rid	string			Restriction profile reference ID

application-ApplicationRef

{
  "id": 13579,
  "rid": "ARID24680",
  "key": "aadgk1357924680"
}

Unique references to the application

Properties

Name	Type	Required	Restrictions	Description
id	integer			Application internal ID
rid	string			Application reference ID
key	string			Application additional unique key that can be used to quickly search the application

surcharge-tariff-plan

{
  "ref": {
    "id": "BHUMNF5OOJEH7AWVPAHS2OY6XYXX",
    "rid": "TP23"
  },
  "name": "Common"
}

Surcharge tariff plan

Properties

Name	Type	Required	Restrictions	Description
ref	surcharge-tariff-plan-SurchargeTariffPlanRef			Reference to the subject type
name	string			Tariff plan name

card-product

{
  "ref": {
    "id": 22,
    "rid": "CPRID22"
  },
  "name": "Unlimited silver",
  "cardClassName": "Smart cards",
  "parentProduct": {
    "id": 22,
    "rid": "CPRID22"
  }
}

Card product object. Card product in TX defines common properties of cards under the product, as well as card production features. Card product can be included into hierarchies, thus allowing to inherit and redefine parameter values, which simplifies product management and control over complicated configurations.

Properties

Name	Type	Required	Restrictions	Description
ref	card-product-CardProductRef			Reference to card product
name	string			Card product name in TX
cardClassName	string			Name of the card class. Card class in TX defines the general card type used for card production, e.g. "Visa Smart Debit/Credit", "MChip Advance", "JCB J/Smart", etc. These classes are predefined in the system and applied during the card product setup in TX. Refer to the TX documentation for a complete list of classes supported.
parentProduct	card-product-CardProductRef			Reference to the parent card product, when used in a hierarchy of card products

contract-ContractRef

{
  "id": 4680,
  "rid": "CRID4542809",
  "extRid": "CASA1268"
}

References to the contract

Properties

Name	Type	Required	Restrictions	Description
id	integer			Contract internal ID
rid	string			Contract reference ID
extRid	string			Contract external reference ID

application-type-ApplicationTypeRef

{
  "id": 12,
  "rid": "ATRID12"
}

Unique references to the application type

Properties

Name	Type	Required	Restrictions	Description
id	integer			Application type internal ID
rid	string			Application type reference ID

subject-NetworkSpecAttrs

[
  {
    "networkName": "string",
    "toDelete": true,
    "rid": "string",
    "merchantRid": "string",
    "singleMerchantRid": "string",
    "name": "string",
    "mcc": "string"
  }
]

List of metwork-specific attributes

Properties

Name	Type	Required	Restrictions	Description
	[subject-NetworkSpecAttr]			List of metwork-specific attributes

contract2contract

{
  "id": 897592,
  "contract1": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "contract1Name": "Digital card",
  "contract2": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "contract2Name": "Revolving",
  "kind": "string",
  "status": "string",
  "seq": 1
}

Object that represents the link between contracts. Links can be used to join separate contracts into one complex product. Each contract performs its own functions and employs the linked contracts, if necessary. A contract can have multiple links to other contracts.

Properties

Name	Type	Required	Restrictions	Description
id	integer			Link ID
contract1	contract-ContractRef			Reference to the first contract in the link
contract1Name	string			The first contract name
contract2	contract-ContractRef			Reference to the second contract in the link
contract2Name	string			The second contract name
kind	string			Link type
status	string			Link status
seq	integer			Link sequence number in contract1

subject-type

{
  "ref": {
    "id": 564,
    "rid": "STRID23"
  },
  "name": "Customer",
  "kind": "Person",
  "parentType": {
    "id": 564,
    "rid": "STRID23"
  }
}

\"Subject type" object. All subjects (persons and companies) in TX belong to the specific type defined in the dictionary of subject types. A "subject type" in TX represents common features of a group of persons or companies of that type. All subject types also belong to a set of basic classes - "individual customer" (person), "corporate customer" (company), or "department".

Properties

Name	Type	Required	Restrictions	Description
ref	subject-type-SubjectTypeRef			Reference to the subject type
name	string			Subject type name
kind	subject-SubjectKind			Kind of the subject
parentType	subject-type-SubjectTypeRef			In case of the subject type hierarchy, contains the reference to the parent subject type in the hierarchy

subject-document-SubjectDocumentRef

{
  "id": 8737
}

Reference to the document

Properties

Name	Type	Required	Restrictions	Description
id	integer			Document internal ID. (!) Please note, this is not the document number.

application-type

{
  "ref": {
    "id": 12,
    "rid": "ATRID12"
  },
  "name": "Credit applications",
  "isAbstract": true,
  "parentType": {
    "id": 12,
    "rid": "ATRID12"
  }
}

Application type object. Application types can be included in a hierarchy of types to simplify the management of applications by using the inbuild inheritance feature of TX.

Properties

Name	Type	Required	Restrictions	Description
ref	application-type-ApplicationTypeRef			Unique references to the application type
name	string			Application type name
isAbstract	boolean			Indicates if the application type can be used to create applications of that type. A value of true indicates that the application type is abstract and is only used to build a hierarchy of application types.
parentType	application-type-ApplicationTypeRef			In case of the application type hierarchy, contains the reference to the parent application type in the hierarchy

tran-TranRef

{
  "id": 7875458909934,
  "matchKey": "trnaadgk1357924680",
  "rqSentTime": "2020-10-21T14:15:00"
}

References to the transaction

Properties

Name	Type	Required	Restrictions	Description
id	integer			Transaction internal ID
matchKey	string			Transaction matching key assigned. Used by TX for transaction matching, and passed in the specific field in the request body - /tranRq/match/key.
rqSentTime	string(date-time)			Date and time when the transaction request was sent to the system. The system will match the matchKey and the transaction regTime within the following windowframe - rqSentTime <= regTimeand <= rqSentTime + 60s

common-UserAttrs

[
  {
    "rid": "UDPRID3",
    "val": "VAL-1"
  }
]

Container of user-defined attributes

Properties

Name	Type	Required	Restrictions	Description
	[common-UserAttr]			Container of user-defined attributes

contract-type-TariffPlan

{
  "ref": {
    "guid": "NPW63LQE2BFWPAQBET4DQIDYNY",
    "rid": "TPRID963"
  },
  "name": "Common pricing plan"
}

Default (shared) tariff plan. "Tariff plan" object in TX represents different pricing parameters such as fees, charges, commissions, interest rates, etc. defined as "Tariff" records in "Tariff plan".

Properties

Name	Type	Required	Restrictions	Description
ref	contract-type-TariffPlanRef			References to default (shared) tariff plan
name	string			Tariff plan name

card-product-CardProductRef

{
  "id": 22,
  "rid": "CPRID22"
}

Reference to card product

Properties

Name	Type	Required	Restrictions	Description
id	integer			Card product ID
rid	string			Card product reference ID

card-CardRef

{
  "id": 13579,
  "rid": "CRDRID24680"
}

References to the card

Properties

Name	Type	Required	Restrictions	Description
id	integer			Card internal ID
rid	string			Card reference ID

contract-type-TariffPlanRef

{
  "guid": "NPW63LQE2BFWPAQBET4DQIDYNY",
  "rid": "TPRID963"
}

References to default (shared) tariff plan

Properties

Name	Type	Required	Restrictions	Description
guid	string			Tariff plan GUID
rid	string			Tariff plan reference ID

subject

{
  "ref": {
    "id": 1746,
    "rid": "PRID73"
  },
  "type": {
    "id": 564,
    "rid": "STRID23"
  },
  "kind": "Person",
  "details": {},
  "networkSpec": [
    {
      "networkName": "string",
      "toDelete": true,
      "rid": "string",
      "merchantRid": "string",
      "singleMerchantRid": "string",
      "name": "string",
      "mcc": "string"
    }
  ],
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Subject (person, company)

Properties

Name	Type	Required	Restrictions	Description
ref	subject-SubjectRef			References to the person/company
type	subject-type-SubjectTypeRef			Reference to the subject type
kind	subject-SubjectKind			Kind of the subject
details	any

anyOf

Name	Type	Required	Restrictions	Description
	object			Details specific to the respective subject class

or

Name	Type	Required	Restrictions	Description
	subject_details-corporation

or

Name	Type	Required	Restrictions	Description
	subject_details-person

continued

Name	Type	Required	Restrictions	Description
networkSpec	subject-NetworkSpecAttrs			Subject network-specific attributes
userAttrs	common-UserAttrs			Subject user-defined attributes

restriction

{
  "ref": {
    "guid": "7febf16f651b43b0a5e30da8da49e",
    "rid": "RRID0847"
  },
  "classGuid": "7febf16f651b43b0a5e30da8da49e90d",
  "name": "Daily usage limit",
  "inUse": true,
  "begTime": "2020-10-21T14:15:00",
  "endTime": "2020-10-22T14:15:00",
  "tmpOff": {
    "begTime": "2020-11-21T14:15:00",
    "endTime": "2020-11-22T14:15:00"
  },
  "maxVal": 10,
  "ccy": "USD",
  "tmpMax": {
    "val": 20,
    "begTime": "2020-10-21T14:15:00",
    "endTime": "2020-10-22T14:15:00"
  },
  "limit": {
    "reset": {
      "periodType": "string",
      "timeOffset": 1440
    },
    "windowSize": 30,
    "curVal": 3,
    "lastResetTime": "2020-10-21T14:15:00"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Restriction object. Restriction object in TX represents different limits, counters and other restrictions that can be applied to cards (tokens), accounts (contracts), customers (subjects) and terminals to control operations, e.g. velocity control limits, permitted transaction types, etc. Restrictions are combined in restriction/risk profiles, that groups limitations of the same category, e.g. "contract restriction profile" is applied to contracts, "card/token risk profile" is applied to cards, etc.

Properties

Name	Type	Required	Restrictions	Description
ref	restriction-RestrictionRef			References to the restriction/limit
classGuid	string			Restriction class unique identifier
name	string			Restriction name (description)
inUse	boolean			Indicates if the restriction is active. A value of true indicates that the restriction is currently in use.
begTime	string(date-time)			Restriction effective time, from
endTime	string(date-time)			Restriction effective time, to
tmpOff	object			Indicates if the restriction is temporarily disabled (during the usage period)
└─ begTime	string(date-time)			Restriction inactivity time, from
└─ endTime	string(date-time)			Restriction inactivity time, to
maxVal	number			Restriction maximum value. For restriction type "limit" it is the maximum accumulated value, for other types of restrictions it is the maximum value of the transaction.
ccy	string			Restriction currency (alpha3 currency code)
tmpMax	object			Temporary maximum value parameters
└─ val	number			Temporary maximum value
└─ begTime	string(date-time)			Temporary maximum value effective, from
└─ endTime	string(date-time)			Temporary maximum value effective, to
limit	object			Limit parameters (applicable to restrictions of "limit" type)
└─ reset	object			Limit reset parameters
‎‎ ‎ └─ periodType	string			Limit reset period
‎‎ ‎ └─ timeOffset	integer			Reset time offset. Defined as the number of minutes after the period start.
└─ windowSize	integer			Accumulation window. Defines how many periods will be used during accumulation.
└─ curVal	number			Currently accumulated value
└─ lastResetTime	string(date-time)			Date/time when the limit was reset last time
userAttrs	common-UserAttrs			User-defined attributes

tran-SrcCard

{
  "pan": 7645346863537866000,
  "expDate": "2027-10-21",
  "cvv2": 222,
  "tds": {
    "version": 2.1,
    "networkType": "string",
    "eci": 5,
    "condition": "string",
    "cavv": 5,
    "dsTranId": 7976543639,
    "xid": "SGVsbG8sIFdvcmxkIQ"
  }
}

Source card details

Properties

Name	Type	Required	Restrictions	Description
pan	string	✔		Card PAN
expDate	string(date)	✔		Card expiration date
cvv2	string			Card CVV2 value
tds	object			e-commerce 3D-Secure details
└─ version	string			3D-Secure (3DS) version, e.g. 1.0, 2.2, etc.
└─ networkType	string			Network type
└─ eci	string			Network related e-commerce indicator
└─ condition	string			3DS authentication conditions
└─ cavv	string			3DS cardholder authentication verification value (CAVV)
└─ dsTranId	string			Transaction ID from Directory Server
└─ xid	string			3DS XID parameter

common-TranRqExtraAttrs

{
  "clerkName": "Operator_1",
  "intMess": 7,
  "textMess": "TTY=8872;SHIF-6839;",
  "categoryCode": "TCC3",
  "categoryText": "Unhandled",
  "classification": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ],
  "match": {
    "key": "adgjl1357guid",
    "rrn": "RN6538303344"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Additional special parameters that can be passed to TX internal RTP transaction (refer to TX RTP specification for more details)

Properties

Name	Type	Required	Restrictions	Description
clerkName	string			Operator name
intMess	integer			Message ID
textMess	string			Text message container
categoryCode	string			Transaction category code
categoryText	string			Transaction category name
classification	common-UserAttrs			Transaction user-defined classifiers, as populated by the system and returned in the form of user-defined properties.
match	common-TranMatch			Transactions matching properties
userAttrs	common-UserAttrs			Transaction additional user-defined properties, configured in the system.

contract-type-ContractTypeRef

{
  "id": 97548,
  "rid": "CTRID975"
}

References to the contract type

Properties

Name	Type	Required	Restrictions	Description
id	integer			Contract type ID
rid	string			Contract type reference ID

tran-Vendor

{
  "rid": "SPRID865439"
}

Reference to the service provider (payments)

Properties

Name	Type	Required	Restrictions	Description
rid	string	✔		Service provider reference ID (payee contract RID)

card-design-CardDesignRef

{
  "id": 12,
  "rid": "DESRID12"
}

Reference to card design

Properties

Name	Type	Required	Restrictions	Description
id	integer			Card design internal ID
rid	string			Card design reference ID

common-ModifyTranApproveRs

{
  "tranId": 1357924680,
  "approvalCode": "A200567",
  "objectId": 77365
}

Properties

allOf

Name	Type	Required	Restrictions	Description
	common-TranApproveRs			Response for approved transaction

and

Name	Type	Required	Restrictions	Description
	object			Response for approved object modification transaction
└─ objectId	integer			Object internal ID in the system

card-design

{
  "ref": {
    "id": 12,
    "rid": "DESRID12"
  },
  "name": "Plain"
}

Card design object

Properties

Name	Type	Required	Restrictions	Description
ref	card-design-CardDesignRef			Reference to card design
name	string			Card design name in TX

restriction-RestrictionRef

{
  "guid": "7febf16f651b43b0a5e30da8da49e",
  "rid": "RRID0847"
}

References to the restriction/limit

Properties

Name	Type	Required	Restrictions	Description
guid	string			Restriction internal ID
rid	string			Restriction reference ID

subject-SubjectKind

"Person"

Kind of the subject

Properties

Name	Type	Required	Restrictions	Description
	string			Kind of the subject

Enumerated Values

Property	Value
	Person
	Corporation

common-MonetaryValue

{
  "amt": 20,
  "ccy": "USD"
}

Amount and currency

Properties

Name	Type	Required	Restrictions	Description
amt	number			Amount
ccy	string			Alpha3 currency code

notification-type

{
  "ref": {
    "id": 87648,
    "rid": "NTRID878"
  },
  "name": "OTP",
  "className": "Base Notifications",
  "parentType": {
    "id": 87648,
    "rid": "NTRID878"
  }
}

Notification type object

Properties

Name	Type	Required	Restrictions	Description
ref	notification-type-NotificationTypeRef			References to the notification type
name	string			Notification type name
className	string			Notification type class (=Notification Contract Type)
parentType	notification-type-NotificationTypeRef			In case of the notification type hierarchy, contains the reference to the parent notification type in the hierarchy

contract

{
  "ref": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  },
  "className": "Contract.Shadow",
  "type": {
    "id": 97548,
    "rid": "CTRID975"
  },
  "client": {
    "id": 1746,
    "rid": "PRID73"
  },
  "details": {},
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Contract object. Contract in TX represents a product common conditions and used by the system to power different services, such as card production ("issuing contract"), operations processing ("financial contract"), customer notifications, etc.

Properties

Name	Type	Required	Restrictions	Description
ref	contract-ContractRef			References to the contract
className	string			Contract class
type	contract-type-ContractTypeRef			References to the contract type
client	subject-SubjectRef			References to the person/company
details	any			Details specific to the respective contract class

anyOf

Name	Type	Required	Restrictions	Description
	object

or

Name	Type	Required	Restrictions	Description
	contract_details-notify

or

Name	Type	Required	Restrictions	Description
	contract_details-merchant-service

or

Name	Type	Required	Restrictions	Description
	contract_details-merchant-settlement

or

Name	Type	Required	Restrictions	Description
	contract_details-trch_rvl_credit

or

Name	Type	Required	Restrictions	Description
	contract_details-shadow

continued

Name	Type	Required	Restrictions	Description
userAttrs	common-UserAttrs			Contract user-defined attributes

common-TranDeclineRs

{
  "tranId": 1357924680,
  "result": "string",
  "code": 888,
  "description": "Not available"
}

Response for declined transaction

Properties

Name	Type	Required	Restrictions	Description
tranId	integer			Unique transaction ID in the system
result	string			Transaction decline result
code	string			Decline reason code
description	string			Decline reason text

contract-type

{
  "ref": {
    "id": 97548,
    "rid": "CTRID975"
  },
  "name": "Revolving credit",
  "contractClassName": "Credit contracts",
  "isAbstract": true,
  "parentType": {
    "id": 97548,
    "rid": "CTRID975"
  },
  "tariffPlans": [
    {
      "ref": {
        "guid": "NPW63LQE2BFWPAQBET4DQIDYNY",
        "rid": "TPRID963"
      },
      "name": "Common pricing plan"
    }
  ]
}

Contract type object. Contract type in TX represents common features, rules and functions of business product or a service. Should not be confused with the "contract class", which is the most generic definition of a business product. Contract type can be included into hierarchies, thus allowing to inherit and redefine parameter values, which simplifies product management and control over complicated configurations.

Properties

Name	Type	Required	Restrictions	Description
ref	contract-type-ContractTypeRef			References to the contract type
name	string			Contract type name
contractClassName	string			Contract class name
isAbstract	boolean			Indicates if the contract type can be used to create contracts of that type. A value of true indicates that the contract type is abstract and is only used to build a hierarchy of contract types.
parentType	contract-type-ContractTypeRef			In case of the contract type hierarchy, contains the reference to the parent contract type in the hierarchy
tariffPlans	[contract-type-TariffPlan]			Default pricing parameters (tariff plans) for the business product, used by all contracts of that type

tran-InstallmentRq

{
  "byMerchant": {
    "typeId": 135,
    "trancheCnt": 5,
    "initialAmt": 237
  },
  "byIssuer": {
    "planId": "CRID245",
    "trancheCnt": 6
  }
}

Parameters related to installment management request

Properties

Name	Type	Required	Restrictions	Description
byMerchant	object			Installment funded by a merchant
└─ typeId	integer			Installment-related Contract Type ID in TX
└─ trancheCnt	integer			Number of installments (without the initial payment)
└─ initialAmt	number			Minimum initial payment amount in transaction currency
byIssuer	object			Installment funded by issuer or financial institution
└─ planId	string			Installment plan ID as installment-related Contract Type RID in TX
└─ trancheCnt	integer			Number of installments

surcharge-tariff-plan-SurchargeTariffPlanRef

{
  "id": "BHUMNF5OOJEH7AWVPAHS2OY6XYXX",
  "rid": "TP23"
}

Reference to the subject type

Properties

Name	Type	Required	Restrictions	Description
id	string			Tariff plan ID
rid	string			Tariff plan reference ID

contract_details-merchant-settlement

{
  "status": "string",
  "name": "The first contract",
  "dates": {
    "creation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "activation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "finish": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "closure": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    }
  },
  "usageRestriction": null,
  "restrictionsProfile": {
    "id": 6846,
    "rid": "RPRID78"
  },
  "sharedTariffPlan": {
    "guid": "NPW63LQE2BFWPAQBET4DQIDYNY",
    "rid": "TPRID963"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
	contract_details			Common properties of contract of any class

and

Name	Type	Required	Restrictions	Description
	object			Merchant settlement contract details

common-UserAttr

{
  "rid": "UDPRID3",
  "val": "VAL-1"
}

User-defined attribute

Properties

Name	Type	Required	Restrictions	Description
rid	string			Reference ID
val	string			Value

contract_details-notify

{
  "status": "string",
  "name": "The first contract",
  "dates": {
    "creation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "activation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "finish": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "closure": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    }
  },
  "usageRestriction": null,
  "restrictionsProfile": {
    "id": 6846,
    "rid": "RPRID78"
  },
  "sharedTariffPlan": {
    "guid": "NPW63LQE2BFWPAQBET4DQIDYNY",
    "rid": "TPRID963"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ],
  "subscriptions": [
    {
      "id": 13579,
      "type": {
        "id": 87648,
        "rid": "NTRID878"
      },
      "status": "string",
      "allowedAddressesIds": [
        0
      ],
      "begSendTime": 420,
      "endSendTime": 1200,
      "options": [
        {
          "rid": "UDPRID3",
          "val": "VAL-1"
        }
      ]
    }
  ],
  "addresses": [
    {
      "id": 46803,
      "isActive": true,
      "channelKind": "string",
      "address": "abnet@mail.net",
      "deviceName": "XCID765369"
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
	contract_details			Common properties of contract of any class

and

Name	Type	Required	Restrictions	Description
	object			Notification contract details. Notification contract describes how the system notifies customers about transactions, events, etc. The customer should have its active notification subscription, which is part of the notification contract. Subscription has different parameters to control and manage respective notifications.
└─ subscriptions	[object]			List of notification subscriptions
‎‎ ‎ └─ id	integer			Subscription ID
‎‎ ‎ └─ type	notification-type-NotificationTypeRef			References to the notification type
‎‎ ‎ └─ status	string			Subscription status
‎‎ ‎ └─ allowedAddressesIds	[integer]			Delivery channel IDs allowed. A value of null indicates that all of addresses are allowed.
‎‎ ‎ └─ begSendTime	integer			The system will not send notifications before this time (as the number of minutes after 00:00). For example, 420 means that the system will not send notifications before 7 AM (7*60).
‎‎ ‎ └─ endSendTime	integer			The system will not send notifications after this time (as the number of minutes after 00:00). For example, 1200 means that the system will not send notifications after 8 PM (20*60).
‎‎ ‎ └─ options	common-UserAttrs			Subscription options configured in TX (as user-defined attributes)
└─ addresses	[object]			Notification channel details
‎‎ ‎ └─ id	integer			Channel ID
‎‎ ‎ └─ isActive	boolean			Channel status. A value of true means that the channel is active.
‎‎ ‎ └─ channelKind	string			Channel type
‎‎ ‎ └─ address	string			Notification delivery address, e.g. phone number, email, etc. For push notifications, contains the application address. A value of null means that the customer's contact information will be used.
‎‎ ‎ └─ deviceName	string			Device name as used for push notifications

subject_details-corporation

{
  "mailAddress": {
    "zip": "NG71AE",
    "country": 0,
    "region": "CAL",
    "regionRid": "string",
    "area": "Nord",
    "areaRid": "string",
    "city": "Homeburg",
    "cityRid": "string",
    "street": "Broadway",
    "streetRid": "string",
    "house": 15,
    "building": 2,
    "construction": 1,
    "flat": 4,
    "addressInCity": null,
    "addressInCountry": null,
    "recipientName": "Robert Smith",
    "phone": 976356838473,
    "fax": null,
    "mobile": 976356838473,
    "email": "r.smith@mymail.net",
    "url": null
  },
  "languageCode": "EN",
  "locale": "en-US",
  "status": "string",
  "notificationContractId": 3987,
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ],
  "parent": {
    "id": 1746,
    "rid": "PRID73"
  },
  "name": "Strong Club",
  "shortName": "S-Club",
  "legalName": "Strong Club Ltd.",
  "latName": "string",
  "address": {
    "zip": "NG71AE",
    "country": 0,
    "region": "CAL",
    "regionRid": "string",
    "area": "Nord",
    "areaRid": "string",
    "city": "Homeburg",
    "cityRid": "string",
    "street": "Broadway",
    "streetRid": "string",
    "house": 15,
    "building": 2,
    "construction": 1,
    "flat": 4,
    "addressInCity": null,
    "addressInCountry": null,
    "recipientName": "Robert Smith",
    "phone": 976356838473,
    "fax": null,
    "mobile": 976356838473,
    "email": "r.smith@mymail.net",
    "url": null
  },
  "legalAddress": {
    "zip": "NG71AE",
    "country": 0,
    "region": "CAL",
    "regionRid": "string",
    "area": "Nord",
    "areaRid": "string",
    "city": "Homeburg",
    "cityRid": "string",
    "street": "Broadway",
    "streetRid": "string",
    "house": 15,
    "building": 2,
    "construction": 1,
    "flat": 4,
    "addressInCity": null,
    "addressInCountry": null,
    "recipientName": "Robert Smith",
    "phone": 976356838473,
    "fax": null,
    "mobile": 976356838473,
    "email": "r.smith@mymail.net",
    "url": null
  },
  "mcc": 5942
}

Properties

allOf

Name	Type	Required	Restrictions	Description
	subject_details			Common properties of subject of any kind

and

Name	Type	Required	Restrictions	Description
	object			Company or corporate customer details
└─ parent	subject-SubjectRef			In case of the company hierarchy, contains the reference to the parent company in the hierarchy
└─ name	string			Company full name
└─ shortName	string			Company short name
└─ legalName	string			Company legal name
└─ latName	string			Company name in latin
└─ address	common-Address			Company contact address
└─ legalAddress	common-Address			Company legal address
└─ mailAddress	common-Address			Company mailing address
└─ mcc	integer			Merchant category code

subject_details-person

{
  "mailAddress": {
    "zip": "NG71AE",
    "country": 0,
    "region": "CAL",
    "regionRid": "string",
    "area": "Nord",
    "areaRid": "string",
    "city": "Homeburg",
    "cityRid": "string",
    "street": "Broadway",
    "streetRid": "string",
    "house": 15,
    "building": 2,
    "construction": 1,
    "flat": 4,
    "addressInCity": null,
    "addressInCountry": null,
    "recipientName": "Robert Smith",
    "phone": 976356838473,
    "fax": null,
    "mobile": 976356838473,
    "email": "r.smith@mymail.net",
    "url": null
  },
  "languageCode": "EN",
  "locale": "en-US",
  "status": "string",
  "notificationContractId": 3987,
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ],
  "lastName": "Doe",
  "firstName": "John",
  "middleName": "V.",
  "birthDate": "2000-10-21",
  "gender": "string",
  "residenceCountry": 840,
  "citizenshipCountry": 840,
  "extraCitizenships": [
    [
      826,
      840
    ]
  ],
  "regAddress": {
    "zip": "NG71AE",
    "country": 0,
    "region": "CAL",
    "regionRid": "string",
    "area": "Nord",
    "areaRid": "string",
    "city": "Homeburg",
    "cityRid": "string",
    "street": "Broadway",
    "streetRid": "string",
    "house": 15,
    "building": 2,
    "construction": 1,
    "flat": 4,
    "addressInCity": null,
    "addressInCountry": null,
    "recipientName": "Robert Smith",
    "phone": 976356838473,
    "fax": null,
    "mobile": 976356838473,
    "email": "r.smith@mymail.net",
    "url": null
  },
  "homeAddress": {
    "zip": "NG71AE",
    "country": 0,
    "region": "CAL",
    "regionRid": "string",
    "area": "Nord",
    "areaRid": "string",
    "city": "Homeburg",
    "cityRid": "string",
    "street": "Broadway",
    "streetRid": "string",
    "house": 15,
    "building": 2,
    "construction": 1,
    "flat": 4,
    "addressInCity": null,
    "addressInCountry": null,
    "recipientName": "Robert Smith",
    "phone": 976356838473,
    "fax": null,
    "mobile": 976356838473,
    "email": "r.smith@mymail.net",
    "url": null
  },
  "emails": [
    "go21@mail.net"
  ],
  "phones": [
    1217077304
  ],
  "workPhones": [
    18938077304
  ],
  "restrictionsProfile": {
    "id": 6846,
    "rid": "RPRID78"
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
	subject_details			Common properties of subject of any kind

and

Name	Type	Required	Restrictions	Description
	object			Person or individual customer details
└─ lastName	string			Last name
└─ firstName	string			First name
└─ middleName	string			Middle name (if applicable)
└─ birthDate	string(date)			Birth date
└─ gender	string
└─ residenceCountry	integer			Country of residence (ISO numeric code)
└─ citizenshipCountry	integer			Country of citizenship, main (ISO numeric code)
└─ extraCitizenships	[integer]			Countries of citizenship, others (ISO numeric code)
└─ regAddress	common-Address			Registration address
└─ homeAddress	common-Address			Living address
└─ emails	[string]			List of e-mails
└─ phones	[string]			List of contact phones
└─ workPhones	[string]			List of work phones
└─ restrictionsProfile	restriction-RestrictionProfileRef			References to the restriction profile

common-TranMatch

{
  "key": "adgjl1357guid",
  "rrn": "RN6538303344"
}

Transactions matching properties

Properties

Name	Type	Required	Restrictions	Description
key	string			Represents the unique key for the operation (transaction). This key is assigned to the operation upon its successful processing (e.g. the object was updated successfully), so in case if the operation result is unknown for any reason, you can just repeat the same request with the same "key". If the transaction is not found in the system, it will be processed as expected, otherwise the system will respond that the transaction was already processed and no changes will be introduced.
rrn	string			Retrieval request number. Used as the transaction reference value in some scenarios, e.g. while processing reversals etc.

contract_details-shadow

{
  "status": "string",
  "name": "The first contract",
  "dates": {
    "creation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "activation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "finish": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "closure": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    }
  },
  "usageRestriction": null,
  "restrictionsProfile": {
    "id": 6846,
    "rid": "RPRID78"
  },
  "sharedTariffPlan": {
    "guid": "NPW63LQE2BFWPAQBET4DQIDYNY",
    "rid": "TPRID963"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ],
  "mainCcy": "USD",
  "permOverdraft": 1000,
  "tmpOverdraft": 0,
  "tmpOverdraftExpiration": "2027-10-21T14:15:00",
  "balances": {
    "available": 5000,
    "ledger": 5200,
    "financial": 5000,
    "curCreditHolds": 200,
    "curDebitHold": 100,
    "permittedOverdraft": 500,
    "debt": 300
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
	contract_details			Common properties of contract of any class

and

Name	Type	Required	Restrictions	Description
	object			\"Shadow" contract details. "Shadow" contract represents the case with the current account when the other system (e.g. Core-banking system) manages the actual account balance, while TX only manages cards and stores account common properties. Usually, such scenario requires an online integration with the account management system to authorize operations and change of the balance.
└─ mainCcy	string			Contract currency (Alpha3 currency code). For multi-currency contracts, it is the main currency of the contract.
└─ permOverdraft	number			Permitted overdraft value, if allowed
└─ tmpOverdraft	number			Temporary overdraft value allowed
└─ tmpOverdraftExpiration	string(date-time)			Temporary overdraft expiration date and time, if applicable
└─ balances	object			Account balances
‎‎ ‎ └─ available	number			Available balance (account balance – debit holds)
‎‎ ‎ └─ ledger	number			Lenger balance (account balance + credit holds)
‎‎ ‎ └─ financial	number			Account balance
‎‎ ‎ └─ curCreditHolds	number			Credit holds, total
‎‎ ‎ └─ curDebitHold	number			Debit holds, total
‎‎ ‎ └─ permittedOverdraft	number			Overdraft amount, available (if applicable)
‎‎ ‎ └─ debt	number			Debt amount, total (if applicable)

subject-document-type-SubjectDocumentTypeRef

{
  "id": 56,
  "rid": "DTRID084"
}

Reference to the document type

Properties

Name	Type	Required	Restrictions	Description
id	integer			Document type ID
rid	string			Document type reference ID

common-Address

{
  "zip": "NG71AE",
  "country": 0,
  "region": "CAL",
  "regionRid": "string",
  "area": "Nord",
  "areaRid": "string",
  "city": "Homeburg",
  "cityRid": "string",
  "street": "Broadway",
  "streetRid": "string",
  "house": 15,
  "building": 2,
  "construction": 1,
  "flat": 4,
  "addressInCity": null,
  "addressInCountry": null,
  "recipientName": "Robert Smith",
  "phone": 976356838473,
  "fax": null,
  "mobile": 976356838473,
  "email": "r.smith@mymail.net",
  "url": null
}

Address and contact details

Properties

Name	Type	Required	Restrictions	Description
zip	string
country	integer			ISO numeric code
region	string
regionRid	string			RID in address database
area	string
areaRid	string			RID in address database
city	string
cityRid	string			RID in address database
street	string
streetRid	string			RID in address database
house	string
building	string
construction	string
flat	string
addressInCity	string
addressInCountry	string
recipientName	string
phone	string
fax	string
mobile	string
email	string
url	string

contract_details-merchant-service

{
  "status": "string",
  "name": "The first contract",
  "dates": {
    "creation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "activation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "finish": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "closure": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    }
  },
  "usageRestriction": null,
  "restrictionsProfile": {
    "id": 6846,
    "rid": "RPRID78"
  },
  "sharedTariffPlan": {
    "guid": "NPW63LQE2BFWPAQBET4DQIDYNY",
    "rid": "TPRID963"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ],
  "settlementContract": {
    "id": 4680,
    "rid": "CRID4542809",
    "extRid": "CASA1268"
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
	contract_details			Common properties of contract of any class

and

Name	Type	Required	Restrictions	Description
	object			Merchant service contract details
└─ settlementContract	contract-ContractRef			References to the contract

contract_details-trch_rvl_credit

{
  "status": "string",
  "name": "The first contract",
  "dates": {
    "creation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "activation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "finish": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "closure": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    }
  },
  "usageRestriction": null,
  "restrictionsProfile": {
    "id": 6846,
    "rid": "RPRID78"
  },
  "sharedTariffPlan": {
    "guid": "NPW63LQE2BFWPAQBET4DQIDYNY",
    "rid": "TPRID963"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ],
  "mainCcy": "USD",
  "cclBaseAmt": 3000,
  "cclTmpAmt": 1000,
  "cclTmpPeriodBeg": "2020-10-21T14:15:00",
  "cclTmpPeriodEnd": "2021-10-21T14:15:00",
  "balances": {
    "available": 3000,
    "ownAvailable": 1000,
    "ledger": 2000,
    "financial": 3000,
    "curCreditHolds": 1000,
    "curDebitHold": 300,
    "debt": 1500,
    "creditLimit": 1500
  }
}

Properties

allOf

Name	Type	Required	Restrictions	Description
	contract_details			Common properties of contract of any class

and

Name	Type	Required	Restrictions	Description
	object			Revolving credit contract additional details
└─ mainCcy	string			Contract currency (Alpha3 currency code). For multi-currency contracts, it is the main currency of the contract.
└─ cclBaseAmt	number			Contract credit limit. This is the common base value of the maximum credit amount allowed. Some credit contracts can also have other special credit limits, e.g. for debt categories. Please refer to the credit contracts configuration in TX for more detials.
└─ cclTmpAmt	number			Temporary credit limit. Once set, is effective during the specified period of time and replaces the base credit limit.
└─ cclTmpPeriodBeg	string(date-time)			Temporary credit limit, effective from
└─ cclTmpPeriodEnd	string(date-time)			Temporary credit limit, effective to
└─ balances	object			Contract balances
‎‎ ‎ └─ available	number			Available balance (account balance – debit holds/used credit + own funds)
‎‎ ‎ └─ ownAvailable	number			Own funds available balance (if applicable). For some products, credit contract allows to have customer's own funds on the balance.
‎‎ ‎ └─ ledger	number			Lenger balance (account balance + credit holds)
‎‎ ‎ └─ financial	number			Account balance
‎‎ ‎ └─ curCreditHolds	number			Credit holds, total
‎‎ ‎ └─ curDebitHold	number			Debit holds, total
‎‎ ‎ └─ debt	number			Debt amount, total
‎‎ ‎ └─ creditLimit	number			Current credit limit. This balance represents the current effective credit limit value, considering active temporary limit and contract's current restrictions.

contract_details-TimeAndBusinessDay

{
  "time": "2020-10-21T14:15:00",
  "businessDay": "2020-10-21"
}

Properties

Name	Type	Required	Restrictions	Description
time	string(date-time)			System time
businessDay	string(date)			Business day

subject_details

{
  "mailAddress": {
    "zip": "NG71AE",
    "country": 0,
    "region": "CAL",
    "regionRid": "string",
    "area": "Nord",
    "areaRid": "string",
    "city": "Homeburg",
    "cityRid": "string",
    "street": "Broadway",
    "streetRid": "string",
    "house": 15,
    "building": 2,
    "construction": 1,
    "flat": 4,
    "addressInCity": null,
    "addressInCountry": null,
    "recipientName": "Robert Smith",
    "phone": 976356838473,
    "fax": null,
    "mobile": 976356838473,
    "email": "r.smith@mymail.net",
    "url": null
  },
  "languageCode": "EN",
  "locale": "en-US",
  "status": "string",
  "notificationContractId": 3987,
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Common properties of subject of any kind

Properties

Name	Type	Required	Restrictions	Description
mailAddress	common-Address			Contact address
languageCode	string			Contact language (ISO alpha-2 language code)
locale	string			Communication locale (IETF language tag)
status	string			Person/company status in TX
notificationContractId	integer			In case if the person/company has active notification subscriptions, the internal ID of the currently active notification contract (also refer to "contract" object for more details)
userAttrs	common-UserAttrs			Container of user-defined attributes

contract_details

{
  "status": "string",
  "name": "The first contract",
  "dates": {
    "creation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "activation": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "finish": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    },
    "closure": {
      "time": "2020-10-21T14:15:00",
      "businessDay": "2020-10-21"
    }
  },
  "usageRestriction": null,
  "restrictionsProfile": {
    "id": 6846,
    "rid": "RPRID78"
  },
  "sharedTariffPlan": {
    "guid": "NPW63LQE2BFWPAQBET4DQIDYNY",
    "rid": "TPRID963"
  },
  "userAttrs": [
    {
      "rid": "UDPRID3",
      "val": "VAL-1"
    }
  ]
}

Common properties of contract of any class

Properties

Name	Type	Required	Restrictions	Description
status	string			Contract status
name	string			Contract name
dates	object
└─ creation	contract_details-TimeAndBusinessDay			Contract creation date
└─ activation	contract_details-TimeAndBusinessDay			Contract activation date
└─ finish	contract_details-TimeAndBusinessDay			Date the contract was prepared for closure
└─ closure	contract_details-TimeAndBusinessDay			Contract closure date
usageRestriction	any			Usage restriction applied to the contract, e.g. due to delinquency state etc.
restrictionsProfile	restriction-RestrictionProfileRef			Reference to contract restriction profile
sharedTariffPlan	contract-type-TariffPlanRef			Reference to common (shared) pricing (tariff plan). The shared tariff plan is defined in the contract type and applicable to all contracts of that type by default, if individual pricing is not applied to the contract.
userAttrs	common-UserAttrs			User-defined attributes