#ResponseWrapperPaymentInstanceDto

Generic API response wrapper

statusstring

Response status

Possible values: [SUCCESS, ERROR]

Example: ERROR/SUCCESS

messagestring

Message describing the response

Example: Request failed/Request successful

codeMessagestring

Code message describing the response

Example: ERR-001/SUC-001

data objectdeprecated

DTO representing the initialized payment instance, including transaction status, OTP configuration, archived tasks, and class metadata.

successboolean

requestIdstring

billPaymentRequestDto object

DTO representing Bill Payment Request

idinteger<int64>

Unique identifier of the bill payment request.

Example: 123456789

customerIdstring

Unique identifier of the customer.

Example: 00801971

customerNamestring

Full name of the customer.

Example: Yassine El Bouzidi

accountNumberstring

Account number to be debited for the bill payment.

Example: 04012086007461825728

accountCurrencystring

Currency code of the account (ISO 4217 format).

Example: MAD

agencyAccountstring

the agency account.

accountLabelstring

Account label or account holder name.

Example: M YASSINE EL BOUZIDI

requestIdstring

Unique identifier of the bill payment request (external reference).

Example: 323456789

transactionBankCodestring

Bank code associated with the transaction.

Example: BANK001

initiatorIdstring

Identifier of the user or system initiating the request.

Example: 123456789

transactionCurrencystring

Currency code of the transaction (ISO 4217 format).

Example: MAD

statusstring

Status of the bill payment request.

Possible values: [ABANDONNE, ANNULE, EN_COURS_DE_SIGNATURE, EN_COURS_DE_TRAITEMENT, REJETE, RETOUR_INITIATEUR, SIGNE, SWIFT_MT700_GENERE, TRAITE, TRAITE_PARTIELLEMENT, A_COMPLETER]

statusCodestring

Status code returned for the bill payment request.

Example: 200

accountProductCodestring

Product code associated with the account.

Example: 192

transactionCurrencyLabelstring

Label of the transaction currency.

Example: Moroccan Dirham

detailedAccountNamestring

Detailed name or description of the account.

Example: Current Account - M YASSINE EL BOUZIDI

externalIdentifierstring

External reference identifier linked to the bill payment.

Example: EXT123456

requestSubmissionDatestring

Date and time when the bill payment request was submitted.

Example: 2025-05-07T14:30:00Z

totalAmountWithTaxnumber<double>

Total amount of the bill including tax.

Example: 1500.75

unpaidItems object[]

List of unpaid items related to the bill payment.

Array [

billerIdstring

Unique identifier of the biller

Example: CN00123456

debtIdstring

Identifier of the related debt

Example: DET00098765

itemIdstring

Unique identifier of the bill

Example: FAC2721176

billDatestring

Bill issue date

Example: 24/06/2024

totalAmountWithTaxnumber<double>

Total amount of the bill including tax

Example: 120.5

itemTypestring

Internal code indicating the bill type

Example: 0

itemTypeLabelstring

Label describing the bill type

Example: Telecom

transactionReferencestring

Transaction reference associated with the bill

Example: TRX-MAR-202406010001

billDateFormattedstring

Formatted bill date for display (ISO 8601)

Example: 2024-06-01

feesnumber<double>

Additional service fees applied to the bill

Example: 10

amountExclTaxnumber<double>

Bill amount before tax

Example: 105

dueDatestring

Bill due date

Example: 2024-06-30

enforceableDatestring

Date when the bill becomes legally enforceable

Example: 2024-07-01

isMandatoryboolean

Indicates if the bill is mandatory for payment

Example: true

customerNamestring

Full name of the client

Example: Mohamed El Amrani

customerPhonestring

Client's Moroccan phone number

Example: 0612345678

customerAddressstring

Address of the client

Example: 123

customerBalancenumber<double>

Client's current account balance in MAD

Example: 500

contractReferencestring

Contract reference related to the bill

Example: 0028120

paymentDeadlinestring

Deadline to pay the bill without penalty

Example: 2024-07-10

penaltyAmountnumber<double>

Penalty amount for delayed payment

Example: 15

billBalancenumber<double>

Remaining amount to be paid on the bill

Example: 120.5

currencystring

Currency of the bill

Example: MAD

paymentMethodstring

Chosen payment method

partialPaymentAmountnumber<double>

Amount proposed for partial payment

Example: 60

isSelectedboolean

Whether the bill is selected for payment

Example: true

paymentOrderinteger<int32>

Priority order in which bills are to be processed

Example: 1

settlementAmountnumber<double>

Final amount to be settled for the bill payment, including all applicable fees and adjustments.

Example: 120.5

debtLabelstring

Descriptive label of the debt type

Example: Produit Internet

billerLabelstring

Name of the biller

Example: Maroc Telecom

feeTypestring

Fee type applied

Example: Service Charge

feeValuenumber<double>

Value of the applied fee

Example: 5

minimumThresholdnumber<double>

Minimum required amount to trigger payment

Example: 20

currencyCodestring

ISO 4217 currency code

Example: MAD

partnerReferencestring

External partner reference code

descriptionstring

Detailed description of the bill

Example: Contract No. 0028120, Type: Telecom, Due: 06/24

]

debtDetails object

Details of the debt associated with the bill payment.

namestring

Name of the debt

Example: Porduit entreprise

codestring

Unique debt code

Example: debt123

categorystring

Category of the debt

Example: telecom_and_internet

billerIdstring

ID of the biller

Example: CR123456

logoPathstring

Path to the biller's logo

Example: https://www.iam.com/logos/biller.png

billerLabelstring

Label or name of the biller

Example: National Telecom Company

billerTypestring

Type of biller

Example: Company

idinteger<int64>

Unique identifier for this debt

Example: 789

refTxFatouratistring

Reference transaction for 'Fatourati' system

Example: FTX123456

feeAmountstring

Total fee amount applied to the bill payment.

Example: 25

partnerReferencestring

partner Reference.

dynamicFormValuesstring

Dynamic form data.

Example: ["field1": "value1", "field2": "value2"]

authorizationWithMiddleBillboolean

Indicates whether the bill payment request requires middle authorization.

Example: false

billPaymentWithMiddleStandardboolean

Indicates whether the bill payment request follows the middle standard processing flow.

Example: false

multiplePaymentAuthorizedboolean

Indicates whether multiple payments are authorized for this bill (null if not applicable).

Example: true

partialPaymentAuthorizedboolean

Indicates whether partial payments are authorized for this bill.

Example: false

statusstring

archivedTasks object[]

Array [

createdOnstring<date-time>

The timestamp when the archived task was created.

Example: 2025-05-01T14:30:00Z

referencestring

Unique reference identifier for the archived task request.

Example: TASK123456789

beneficiarystring

Name of the beneficiary involved in the task.

Example: YASSINE

transactionTypestring

Type of the transaction that was processed

Example: Bill Payment

statusstring

Current status of the archived task.

actionLabelstring

A label that describes the action performed in the task

createdBystring

Identifier of the user or system that created or initiated the task.

userFullNamestring

Full name of the user associated with the task.

Example: YASSINE EL BOUZIDI

amountnumber

The amount involved in the task.

Example: 1500

debitAccountstring

Account number from which funds were withdrawn or charged.

Example: 1234567890

creditAccountstring

Account number to which funds were credited or deposited.

Example: 0987654321

clientReferentstring

The client referent

]

classNamestring

error object

Details of any error that occurred

codestring

Error code

Example: ERR-142

messagestring

Human-readable error message

Example: Resource not found

details object[]

List of error details

Array [

codestring

Specific error code

Example: ER4001

messagestring

What went wrong

Example: Invalid input

targetstring

Field that caused the issue

Example: username

]

suggestionsstring[]

Suggested fixes

Example: ["Check the resource ID","Ensure the resource exists"]

metaData object

Extra metadata to help debugging

property name*string

timestampstring<date-time>

Timestamp of when the response was generated

Example: 22024-10-14T14:28:11.284+01:00

ResponseWrapperPaymentInstanceDto

{
  "status": "ERROR/SUCCESS",
  "message": "Request failed/Request successful",
  "codeMessage": "ERR-001/SUC-001",
  "error": {
    "code": "ERR-142",
    "message": "Resource not found",
    "details": [
      {
        "code": "ER4001",
        "message": "Invalid input",
        "target": "username"
      },
      {
        "code": "ER4002",
        "message": "Missing field",
        "target": "email"
      }
    ],
    "suggestions": [
      "Check the resource ID",
      "Ensure the resource exists"
    ],
    "metaData": {}
  },
  "timestamp": "22024-10-14T14:28:11.284+01:00"
}