Collect a Payment from a User

post

https://api.staging.fiant.io/v1/transactions/payments

This endpoint is used to execute a generic payment of fiat or crypto transaction for a User. The Transaction Assessment and User information requirement are evaluated before the transaction is executed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Collect payment from the initiator, the beneficiary is the Client platform's specified Wallet in the destinationMethod(if specified).

sourceMethod

required

destinationMethod

object

type

string

enum

required

string

length ≤ 64

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

The id of the transaction/payment. Optional, will be populated with the value provided in the x-pti-request-id header.

transactionGroupId

string

length ≤ 64

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

If your system performs transactions that are together part of an overall transaction group, use this to tie them together

subClientId

string

length ≤ 64

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

If your system is multi-tenant and you have this is the id of your client that is making the request

transactionTotal

object

usdValue

double

0 to 999999

amount

double

required

0 to 999999

date

string

required

length ≤ 40

^(?:[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)

ISO-8601

initiator

required

ptiMeta

object

key/value map of extra meta data for this request (used by PTI)

clientMeta

object

key/value map of extra meta data for this request (used by Client)

deviceInformation

object

Headers

x-pti-request-id

string

required

length ≤ 64

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

Unique identifier of the request. This ID must be provided and stored by the client of this API at the creation of a transaction. This ID is attached to all PTI internal operations as well as the webhook calls. This ID is required to post feedback about a transaction and get support from PTI for a problem on a transaction. Creating two transactions having the same requestId is not allowed.

x-pti-scenario-id

string

required

length ≤ 64

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

Represents a User action under which transaction amounts will accumulated and will control the User Assessment requirements. The values this header can take must be agreed upon and communicated to PTI. Setting unknown values here will generate an error.

x-pti-session-id

string

length ≤ 64

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

Session ID associated to a UI session for a specific User. Should match the value passed to the PTI SDK at initialization.

x-pti-disable-webhook

boolean

Set to true to disable webhook calls for this request.

x-pti-provider-name

string

length ≤ 64

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

Used to specify which provider is responsible for handling the given operation. Ignored if the client configuration is not set for passive mode.

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

Callback

201Successfully initiated the transaction

400Invalid fields on Transaction

401unauthorized

403Forbidden. Happens when the targeted User is not active.

404User not found

422One of these 2 cases: More information about the User is needed in order to approve the transaction. There is no approved assessment for this User that enables him to perform the operation.

defaultunexpected error