Create a Transaction

POST {{baseurl}}/v2/api/evaluations

This endpoint is used to send or stream a single financial transaction associated with an existing client (individual or business client) for evaluation.

Header

Name	Type	Description
token*	String	API token

Body

Name	Type	Description
transaction*	Object	Transaction information
channel	String	The type of channel that was used to initiate the transaction
currency*	String	The 3-character currency code: USD
localCurrency	String	The 3-character currency code: USD
amount*	Float	The amount in the currency stated (in the currency field) for this transaction
balance	Float	The balance of the account after the transaction has taken place
localAmount	Float	Amount converted to the local currency of the financial institution.
transactionMethod*	String	The method or type of transaction. It can be: FEE,INTEREST,CASH,CHECK,PAYMENT,DIRECT_DEBIT,STANDING_ORDER, TRANSFER
transactionType*	String	The direction of flow for the transaction. It can be CREDIT,DEBIT
checkNumber	String	If the transaction's transactionMethod field is CHECK, this field must contain the associated check number
channelIpAddress	String	The IP address for the channel associated with the transaction
internationalTransaction	Boolean	This indicates if the transaction is international
description	String	This captures the description of the transaction
status	String	The status of the transaction. It can be either be COMPLETE,PENDING,VOID,FAILED
cardType	String	The type of the card. It can be PHYSICAL, VIRTUAL
cardIssuedCountry	String	The card issuer's country code. This is the ISO alpha-2 country code: US
cardLast4Digits	String	The 4 digits of the card
cardExpiry	String	The expiration date of the card. It is represented in month and year: 08/23
cardBrand	String	The brand of the card. It can be VISA,MASTERCARD,AMERICAN_EXPRESS,DISCOVER,UNIONPAY,RUPAY,JCB,VERVE
InteractionPoint	String	This is the mode in which the transaction was initiated. It can be ATM,CARD_SWIPE_TERMINAL,MOBILE,ONLINE,POS,BRANCH,UNKOWN
merchantCountryCode	String	The country code of the merchant. It should be in the ISO alpha-2 format: US
merchantCategoryCode	String	The merchant category code for the business or legal entity
transactionDate*	String	the date of the transaction. It must be in this format "2023-06-26T00:15:35.445Z"
settledAt	String	This should be the same as the transaction date. It must be in this format "2023-06-26T00:15:35.445Z"
source*	Object	This contains information about the source of the transaction
accountType*	String	This is the type of account of the source transaction. It can be: LEGAL_ENTITY,INDIVIDUAL
accountName	String	The name of the account holder of the source transaction. If not a legal entity, it must be in (First Name, Middle Name, Last Name) order
accountNumber*	String	The bank account number of the sender
bankCode	String	The bank code or Bank Identifier Code is a unique code for the bank. In some countries it can also be the SWIFT code.
beneficiary*	Object	This contains information about the beneficiary of the transaction
accountClass	String	The account class of the beneficiary. It can be: DEPOSIT,CREDIT,BROKERAGE
accountNumber*	String	The bank account number of the beneficiary
bankName*	String	The name of the bank of the beneficiary
accountName*	String	The name of the account holder of the beneficiary. If not a legal entity, it must be in (First Name, Middle Name, Last Name) order
accountType*	String	The account type of the beneficiary: It can be LEGAL_ENTITY,INDIVIDUAL
merchantCategoryCode	String	The merchant category code for the beneficiary if it is a legal entity
merchantCountryCode	String	The country code of the merchant. It should be in the ISO alpha-2 format: US
routingNumber	String	The routing number of the beneficiary's bank
openingDate	String	The opening date of the account. The acceptable format is: 2023-06-26T00:15:35.445Z
bankCode	String	The bank code or Bank Identifier Code is a unique code for the bank. In some countries it can also be the SWIFT code.
iban	String	IBAN (International Bank Account Number)
swift	String	SWIFT (Society for Worldwide Interbank Financial Telecommunication) code
cifNumber	String	CIF (Customer Information File) number
avs	String	AVS (Address Verification System) code
isLinkedAccount	Boolean	This indicates if the account is linked
addressCity	String	The city of the beneficiary's residence address
addressState	String	The state of the beneficiary's residence address
addressPostalCode	String	The postal code of the beneficiary's residence address
addressCountryCode	String	The beneficiary's country of residence. It should be in the ISO alpha-2 format: US

Sample Request

{
     transaction: {
       source: {
         accountType: 'INDIVIDUAL',
         accountClass: 'DEPOSIT',
         accountNumber: '293920300',
         bankCode: '1234'
       },
       beneficiary: {
         accountClass: 'DEPOSIT',
         accountType: 'INDIVIDUAL',
         routingNumber: '',
         openingDate: '2023-06-26T00:15:35.445Z',
         iban: '',
         swift: '',
         cifNumber: '',
         avs: '',
         isLinkedAccount: false,
         addressCity: '',
         addressState: '',
         addressPostalCode: '10001',
         addressCountryCode: 'US',
         accountNumber: '0989067890',
         accountName: 'Jane Doe',
         bankName: 'Societe',
         merchantCategoryCode: '1234',
         merchantCountryCode: 'US',
         bankCode: '1234'
       },
       amount: 593000,
       localAmount: 0,
       balance: 0,
       transactionDate: '2024-03-01T13:04:15.000Z',
       settledAt: '2024-02-09T13:04:15.000Z',
       localCurrency: "USD",
       transactionMethod: 'TRANSFER',
       transactionType: 'CREDIT',
       channelIpAddress: "10.0.0.1",
       internationalTransaction: false,
       interactionPoint: 'ATM',
       description: null,
       status: 'FAILED',
       merchantCategoryCode: '529',
       cardType: 'PHYSICAL',
       cardBrand: '',
       cardExpiry: '09/22',
       checkNumber: '',
       cardLast4Digits: '0000',
       cardIssuedCountry: 'US',
       channel: 'MOBILE',
       currency: 'USD',
       merchantCountryCode: 'US',
     }
   }

Success Response

{
       "success": true,
       "statusCode": 201,
       "message": "Transaction successfully created and sent for evaluation!",
       "data": {},
       "links": []
     }

Error Responses

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}