Package com.flagright.api.resources.transactions

Class TransactionsClient

java.lang.Object

com.flagright.api.resources.transactions.TransactionsClient

public class TransactionsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
TransactionsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
TransactionWithRulesResult	get(java.lang.String transactionId)	GET Transactions
TransactionWithRulesResult	get(java.lang.String transactionId, RequestOptions requestOptions)	GET Transactions
TransactionsVerifyResponse	verify(TransactionsVerifyRequest request)	POST Transactions
TransactionsVerifyResponse	verify(TransactionsVerifyRequest request, RequestOptions requestOptions)	POST Transactions
RawTransactionsClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

TransactionsClient

public TransactionsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawTransactionsClient withRawResponse()

Get responses with HTTP metadata like headers

verify

public TransactionsVerifyResponse verify(TransactionsVerifyRequest request)

POST Transactions

/transactions endpoint allows you to operate on the Transaction entity.

In order to pass the payload of a transaction to Flagright and verify the transaction, you will need to call this endpoint with the transaction payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup.

Payload

Here are some of the most used payload fields explained (you can find the full payload schema below with 1 line descriptions):

• type: Type of transaction (Ex: WITHDRAWAL, DEPOSIT, TRANSFER etc).
• transactionId - Unique Identifier for the transaction.
• timestamp - UNIX timestamp in milliseconds of when the transaction took place
• transactionState - The state of the transaction, set to CREATED by default. More details here
• originUserId - Unique identifier (if any) of the user who is sending the money. This user must be created within the Flagright system before using the create a consumer user or create a business user endpoint
• destinationUserId - Unique identifier (if any) of the user who is receiving the money. This user must be created within the Flagright system before using the create a consumer user or create a business user endpoint
• originAmountDetails - Details of the amount being sent from the origin
• destinationAmountDetails - Details of the amount being received at the destination
• originPaymentDetails - Payment details (if any) used at the origin (ex: CARD, IBAN, WALLET etc). You can click on the dropdown next to the field in the schema below to view all supported payment types.
• destinationPaymentDetails - Payment details (if any) used at the destination (ex: CARD, IBAN, WALLET etc). You can click on the dropdown next to the field in the schema below to view all supported payment types.

verify

public TransactionsVerifyResponse verify(TransactionsVerifyRequest request,
                                         RequestOptions requestOptions)

POST Transactions

/transactions endpoint allows you to operate on the Transaction entity.

In order to pass the payload of a transaction to Flagright and verify the transaction, you will need to call this endpoint with the transaction payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup.

Payload

Here are some of the most used payload fields explained (you can find the full payload schema below with 1 line descriptions):

• type: Type of transaction (Ex: WITHDRAWAL, DEPOSIT, TRANSFER etc).
• transactionId - Unique Identifier for the transaction.
• timestamp - UNIX timestamp in milliseconds of when the transaction took place
• transactionState - The state of the transaction, set to CREATED by default. More details here
• originUserId - Unique identifier (if any) of the user who is sending the money. This user must be created within the Flagright system before using the create a consumer user or create a business user endpoint
• destinationUserId - Unique identifier (if any) of the user who is receiving the money. This user must be created within the Flagright system before using the create a consumer user or create a business user endpoint
• originAmountDetails - Details of the amount being sent from the origin
• destinationAmountDetails - Details of the amount being received at the destination
• originPaymentDetails - Payment details (if any) used at the origin (ex: CARD, IBAN, WALLET etc). You can click on the dropdown next to the field in the schema below to view all supported payment types.
• destinationPaymentDetails - Payment details (if any) used at the destination (ex: CARD, IBAN, WALLET etc). You can click on the dropdown next to the field in the schema below to view all supported payment types.

get

public TransactionWithRulesResult get(java.lang.String transactionId)

GET Transactions

/transactions endpoint allows you to operate on the Transaction entity.

Calling GET /transactions/{transactionId} will return the entire transaction payload and rule execution results for the transaction with the corresponding transactionId

get

public TransactionWithRulesResult get(java.lang.String transactionId,
                                      RequestOptions requestOptions)

GET Transactions

/transactions endpoint allows you to operate on the Transaction entity.

Calling GET /transactions/{transactionId} will return the entire transaction payload and rule execution results for the transaction with the corresponding transactionId