Update status on existing transaction

post

https://api.staging.fiant.io/v1/transactions/{requestId}/updates

This endpoint allows adding feedback information to an existing transaction. Here are the possible feedback values with their meaning:

Feedback	Meaning
`ACCEPTED`	The transaction was accepted by the processor and is deemed to be in a pending state. This feedback is not a final state and should be followed by antoher feedback such as `SETTLED` or `CANCELLED`
`PENDING_SETTLEMENT`	A trade transaction is being processed by the processor and is awaiting settlement.
`SETTLED`	The transaction was accepted and fully finalized by the processor. The transfer of value has occured.
`CANCELLED`	The transaction was accepted but cancelled prior to being settled
`AWAITING_PAYMENT`	A deposit transaction is being processed and is in a state where it is waiting for the user to complete the payment by funding the target address provided or making a deposit using the specified payment method.
`REJECTED`	The transaction was declined by the processor
`REFUNDED`	An intentional, settled transaction was refunded
`CHARGED_BACK`	A settled transaction was disputed and refunded
`ERROR`	The processor returned an error, the transaction is assumed to be non existent from the processor standpoint
`RETURNED`	The transaction could not be processed and will be returned to the originating bank.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

requestId

string

required

length ≤ 64

^[a-z0-9_-]{3,64}$

Request ID used when the transaction was initially logged

Body Params

Feedback to associate to the existing transaction

Set of possible transaction feedbacks

payload

string

providerName

string

length ≤ 64

^[A-Za-z0-9\-_]{3,64}$

A provider identifier. Can be any alphanumeric string (3-64 chars), but the following are commonly used values: PTI_LEDGER, UNKNOWN, WORLDPAY, TRMLABS, SARDINE, CIRCLE, TABAPAY, AU10TIX, OPEN_SANCTION, COINBASE_PRIME, COINBASE_EXCHANGE, CHECKOUT, FORTE, M_AND_T, CROSS_RIVER_BANK, FIREBLOCKS, BANKING example: PTI_LEDGER

feedback

string

enum

required

transactionId

string | null

^[A-Za-z0-9\-_]{3,256}$

A transaction hash or any relevant identifier for the transaction

date

string | null

^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|[+-][01]\d:[0-5]\d)

Timestamp when the transaction feedback changed. This will be used in transaction reports. If not provided, it will be set to the time at which the api call is made. The format must be compatible with the ISO-8601 standard. e.g. 2022-01-01T00:00:00

Headers

x-pti-client-id

string

required

length ≤ 64

^[a-z0-9_-]{3,64}$

Client ID provided to you during onboarding.

Responses

429

Too many requests

201Successfully added transaction feedback. Returns the requestId in the id value of the response.

400Missing required fields on transaction feedback

401unauthorized

404Transaction identified by requestId not found

defaultunexpected error