Attempt

Présentation  

Ce objet représente une, tentative d'exécuter une operation dont le bon déroulement conduira à la création d'un objet Transaction.
Ainsi, chaque fois que vous initiez un Dépôt ou un Transfert, un objet Attempt sera créé et son id sera accessible avec le champ attemptId.
Concernant les objects FundRequest et  QuasiTransfer, un objet Attempt sera créé uniquement lorsque votre utilisateur essaiera de vous payer via une FundRequest ou de récupérer son argent via un QuasiTransfer: Il permettra alors de suivre le processus ainsi enclenché.

Opérations  

get  

Retourne un objet Attempt identifié par un identifiant.
 Le seul champ pouvant servir d'identifiant pour cette opération est le champ id

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

Liste Filtre & Tri  

Les QSQuery ne sont pas supportées par cet objet.

Champs  

createdTime

UTCDateTime
Date et heure auxquelles cet objet a été créé. Valeur toujours stockée en UTC (Temps universel), ce champ contient une representation de cet instant au format ISO 8601 ainsi qu'une representation de ce même instant en timestamp secondes et millisecondes.

iso8601

string
Date et heure au format ISO 8601

timestamp

Timestamp

milliseconds

number
Date et heure exprimées en Timestamp milli secondes

seconds

Double
Date et heure exprimées en Timestamp secondes

id

string
Identifiant unique et non modifiable formé de chiffres et de lettres.

parentId

string
ID de l'objet parent qui a entrainé la création de ce present objet.

parentType

string
Type de l'objet parent qui a entrainé la création de ce present objet.

Les seules valeurs possibles sont: "Deposit"  "FormulaPurchase"  "FundRequest"  "QuasiTransfer"  "Refund"  "Transfer"  

status

AttemptStatus

AttemptStatus.Completing
Completing

_type

string

La seule valeur possible est: "Completing"  

AttemptStatus.Failure
Failure

_type

string

La seule valeur possible est: "Failure"  

cancelled

Cancelled | undefined

afterTimeout

boolean

reason

LocalizedText

en

string

fr

string

AttemptStatus.OnGoing
OnGoing

_type

string

La seule valeur possible est: "OnGoing"  

AttemptStatus.Successful
Successful

_type

string

La seule valeur possible est: "Successful"  

url

string
URL sur laquelle une methode GET convenablement autorisée renverra l'instance de l'objet sur lequel ce champ est défini.

validations

Array<AttemptValidation>

mfa

MfaProcess
Modélise le processus d'Authentification Multi Facteur dans le cadre de cette opération. Si pour éffectuer cette opération, un code secret est demandé à l'utilisateur à des fins de validation, les actions qu'il doit effectuer ainsi que le delai d'expiration au bout duquel la validation doit avoir été effectuée seront contenus ici.
Ce champ représente un processus donc ses valeurs sont sunt susceptibles de changer suivant les actions effectuée par l'utilisateur.
Initialement, ce champ aura pour type "MfaProcess.WaitingToStart", "MfaProcess.Starting" ou "MfaProcess.NotRequired"
Si ce champ a pour type "MfaProcess.NotRequired", alors l'Authentification Multi Facteur n'est pas requise pour éffectuer cette opération.
Si ce champ a pour type "MfaProcess.Successful", alors l'Authentification Multi Facteur a réussie
Si ce champ a pour type "MfaProcess.Failed", alors l'Authentification Multi Facteur a échouée et il est possible de savoir si ce processus a échoué car il a été annulé ou pas avec les champs de cet objet.

MfaProcess.Failure
Failure

_type

string

La seule valeur possible est: "Failure"  

id

string
Identifiant unique et non modifiable formé de chiffres et de lettres.

reason

LocalizedText

en

string

fr

string

MfaProcess.NotRequired
NotRequired

_type

string

La seule valeur possible est: "NotRequired"  

MfaProcess.OneTimePasswordRequired
OneTimePasswordRequired

_type

string

La seule valeur possible est: "OneTimePasswordRequired"  

confirm

MfaProcessConfirm

method

string

placeHolder

string

url

string
URL sur laquelle une methode GET convenablement autorisée renverra l'instance de l'objet sur lequel ce champ est défini.

id

string
Identifiant unique et non modifiable formé de chiffres et de lettres.

otp

Otp

action

OtpAction

channel

OtpChannel

OtpChannel.EmailChannel
EmailChannel

_type

string

La seule valeur possible est: "EmailChannel"  

value

string

OtpChannel.SmsChannel
SmsChannel

_type

string

La seule valeur possible est: "SmsChannel"  

value

string

expire

Expire
Si présent alors cette valeur indique que cet objet à une date d'expiration et sera annulé une fois celle ci arrivée.

delay

Duration
Durée après laquelle cet objet expire.

iso8601

string
Durée au format ISO 8601

milliseconds

Double
Durée exprimée en milli secondes

seconds

Double
Durée exprimée en secondes

time

UTCDateTime

iso8601

string
Date et heure au format ISO 8601

timestamp

Timestamp

milliseconds

number
Date et heure exprimées en Timestamp milli secondes

seconds

Double
Date et heure exprimées en Timestamp secondes

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

La seule valeur possible est: "SecretCodeRequired"  

expire

Expire
Si présent alors cette valeur indique que cet objet à une date d'expiration et sera annulé une fois celle ci arrivée.

delay

Duration
Durée après laquelle cet objet expire.

iso8601

string
Durée au format ISO 8601

milliseconds

Double
Durée exprimée en milli secondes

seconds

Double
Durée exprimée en secondes

time

UTCDateTime

iso8601

string
Date et heure au format ISO 8601

timestamp

Timestamp

milliseconds

number
Date et heure exprimées en Timestamp milli secondes

seconds

Double
Date et heure exprimées en Timestamp secondes

id

string
Identifiant unique et non modifiable formé de chiffres et de lettres.

provider

MoneyAccountProvider

country

Country

iso3166

Iso3166Country

alpha2

string
Code ISO 3166 comportant 2 caractères représentant le pays.
Exemple : "CI" pour la Côte d'Ivoire, "BF" pour le Burkina Faso et "SN" pour le Sénégal.

alpha3

string
Code ISO 3166 comportant 3 caractères représentant le pays.
Exemple : "CIV" pour la Côte d'Ivoire, "BFA" pour le Burkina Faso et "SEN" pour le Sénégal.

name

string
Nom du pays qui sera soit en Français ou soit en Anglais suivant la langue de votre compte FPay. Si lors de votre inscription, vous avez choisi le Français comme langue de votre compte alors, le nom du pays sera en Français et si vous avez choisi l'anglais, alors ce nom sera en Anglais.

key

string
Clé identifiant de manière unique le fournisseur de compte sur lequel se trouve de l'argent.

Les seules valeurs possibles sont: "FPay"  "MoovMoney"  "MtnMoney"  "OrangeMoney"  

name

string
Nom du fournisseur de compte sur lequel se trouve de l'argent.

requiredAction

LocalizedVariableText

en

VariableText

text

string

variables

Array<string>

fr

VariableText

text

string

variables

Array<string>

MfaProcess.Starting
Starting

_type

string

La seule valeur possible est: "Starting"  

id

string
Identifiant unique et non modifiable formé de chiffres et de lettres.

MfaProcess.Successful
Successful

_type

string

La seule valeur possible est: "Successful"  

id

string
Identifiant unique et non modifiable formé de chiffres et de lettres.

MfaProcess.WaitingToStart
WaitingToStart

_type

string

La seule valeur possible est: "WaitingToStart"  

id

string
Identifiant unique et non modifiable formé de chiffres et de lettres.