Attempt

Introducing  

This object represents an attempt to execute an operation, the successful completion of which will lead to the creation of a Transaction object. Thus, each time you initiate a Deposit or Transfer, an Attempt object will be created and its id will be accessible via the attemptId field. For the FundRequest and QuasiTransfer objects, an Attempt object will only be created when your user attempts to pay you via a FundRequest or to retrieve his money via a QuasiTransfer: it will then allow you to track the process.

Operations  

get  

Returns an object Attempt found by an identifier.
 The only field that can be used as an identifier for this operation is the id

const attemptPromise = fPay.attempt.get("identifier");

List Filter & Sort  

QSQueries are not supported by this object.

Fields  

createdTime

UTCDateTime
Date and time at which this object was created. Value always stored in UTC (Universal Time), this field contains a representation of this instant in ISO 8601 format, as well as a representation of this same instant in timestamp seconds and milliseconds.

iso8601

string
Date and time in ISO 8601 format

timestamp

Timestamp

milliseconds

number
Date and time in timestamp milli seconds

seconds

Double
Date and time in timestamp seconds

id

string
Unique, unchangeable identifier made up of numbers and letters.

parentId

string
ID of the parent object that led to the creation of this present object.

parentType

string
Type of the parent object that led to the creation of this present object.

The only possible values are"Deposit"  "FormulaPurchase"  "FundRequest"  "QuasiTransfer"  "Refund"  "Transfer"  

status

AttemptStatus

AttemptStatus.Completing
Completing

_type

string

The only possible value is"Completing"  

AttemptStatus.Failure
Failure

_type

string

The only possible value is"Failure"  

cancelled

Cancelled | undefined

afterTimeout

boolean

reason

LocalizedText

en

string

fr

string

AttemptStatus.OnGoing
OnGoing

_type

string

The only possible value is"OnGoing"  

AttemptStatus.Successful
Successful

_type

string

The only possible value is"Successful"  

url

string
URL on which a properly authorized GET method will return the instance of the object on which this field is defined.

validations

Array<AttemptValidation>

mfa

MfaProcess
Models the Multi-Factor Authentication process for this operation. If, in order to perform this operation, the user is asked to enter a secret code for validation purposes, the actions to be carried out by the user and the expiry date by which validation must be completed will be contained here.
This field represents a process, so its values are likely to change according to the actions performed by the user..
Initially, this field will have the type “MfaProcess.WaitingToStart”,“MfaProcess.Starting” or “MfaProcess.NotRequired” If this field has the type “MfaProcess.NotRequired” , then Multi-Factor Authentication is not required to perform this operation. If the type of this field is “MfaProcess.Successful”, then Multi Factor Authentication has succeeded. If the type of this field is “MfaProcess.Failed”, then Multi Factor Authentication has failed and it's possible to find out whether this process failed because it was cancelled or not using the fields in this object.

MfaProcess.Failure
Failure

_type

string

The only possible value is"Failure"  

id

string
Unique, unchangeable identifier made up of numbers and letters.

reason

LocalizedText

en

string

fr

string

MfaProcess.NotRequired
NotRequired

_type

string

The only possible value is"NotRequired"  

MfaProcess.OneTimePasswordRequired
OneTimePasswordRequired

_type

string

The only possible value is"OneTimePasswordRequired"  

confirm

MfaProcessConfirm

method

string

placeHolder

string

url

string
URL on which a properly authorized GET method will return the instance of the object on which this field is defined.

id

string
Unique, unchangeable identifier made up of numbers and letters.

otp

Otp

action

OtpAction

channel

OtpChannel

OtpChannel.EmailChannel
EmailChannel

_type

string

The only possible value is"EmailChannel"  

value

string

OtpChannel.SmsChannel
SmsChannel

_type

string

The only possible value is"SmsChannel"  

value

string

expire

Expire
If present, then this value indicates that this object has an expiry date and will be cancelled when it expires.

delay

Duration
Duration after which this object expires.

iso8601

string
Duration in ISO 8601 format

milliseconds

Double
Duration in milli seconds

seconds

Double
Duration in seconds

time

UTCDateTime

iso8601

string
Date and time in ISO 8601 format

timestamp

Timestamp

milliseconds

number
Date and time in timestamp milli seconds

seconds

Double
Date and time in timestamp seconds

nbVerifyAttempts

number

prefix

string | undefined

requiredAction

LocalizedVariableText

en

VariableText

text

string

variables

Array<string>

fr

VariableText

text

string

variables

Array<string>

MfaProcess.SecretCodeRequired
SecretCodeRequired

_type

string

The only possible value is"SecretCodeRequired"  

expire

Expire
If present, then this value indicates that this object has an expiry date and will be cancelled when it expires.

delay

Duration
Duration after which this object expires.

iso8601

string
Duration in ISO 8601 format

milliseconds

Double
Duration in milli seconds

seconds

Double
Duration in seconds

time

UTCDateTime

iso8601

string
Date and time in ISO 8601 format

timestamp

Timestamp

milliseconds

number
Date and time in timestamp milli seconds

seconds

Double
Date and time in timestamp seconds

id

string
Unique, unchangeable identifier made up of numbers and letters.

provider

MoneyAccountProvider

country

Country

iso3166

Iso3166Country

alpha2

string
ISO 3166 code with 2 characters representing the country.
Example: “CI” for Côte d'Ivoire, “BF” for Burkina Faso and “SN” for Senegal.

alpha3

string
ISO 3166 code with 3 characters representing the country.
Example: “CIV” for Côte d'Ivoire, “BFA” for Burkina Faso and “SEN” for Senegal.

name

string
Country name in either English or French, depending on the language of your FPay account. If, when you registered, you chose French as the language of your account, then the country name will be in French. in French and if you have chosen English, then this name will be in English.

key

string
Key uniquely identifying the money account provider.

The only possible values are"FPay"  "MoovMoney"  "MtnMoney"  "OrangeMoney"  

name

string
Money account provider name

requiredAction

LocalizedVariableText

en

VariableText

text

string

variables

Array<string>

fr

VariableText

text

string

variables

Array<string>

MfaProcess.Starting
Starting

_type

string

The only possible value is"Starting"  

id

string
Unique, unchangeable identifier made up of numbers and letters.

MfaProcess.Successful
Successful

_type

string

The only possible value is"Successful"  

id

string
Unique, unchangeable identifier made up of numbers and letters.

MfaProcess.WaitingToStart
WaitingToStart

_type

string

The only possible value is"WaitingToStart"  

id

string
Unique, unchangeable identifier made up of numbers and letters.