• English
  • Pay In Order Notification

    Notify request path

    Pay in order Notify URL, please configure it in Web Business -> Pay-In -> Virtual Account -> Webhook

    Notify parameter list

    NameTypeLengthRequiredDescription
    orderNoString32yesPalmPay platform order No
    orderStatusInteger3yesVirtual Account order status (see Virtual Account order status)
    createdTimeLong13yesOrder create time
    updateTimeLong13yesOrder update time
    currencyString3yesCurrency(NGN) Data Dictionary
    orderAmountLong19yesThe initiated amount of the external transfer (Unit of measurement: cent For example, "100" means 1 NGN)
    referenceString512noPayer reference
    payerAccountNoString64yesPayer account number
    payerAccountNameString200yesPayer account name
    payerBankNameString64yesPayer bank name
    virtualAccountNoString64noVirtual account number(Only transfers to the virtual account will be returned, transfers to the merchant's balance will not be returned)
    virtualAccountNameString200noVirtual account name(Only transfers to the virtual account will be returned, transfers to the merchant's balance will not be returned)
    accountReferenceString120noThis is a reference field for the virtual account.
    sessionIdString128NoChannel Response Parameters. Note: Most of the non-NIBSS channels do not return sessionId, if there is any problem with this type of order, you need to provide the order number to PalmPay to confirm the actual arrival of the payee.
    signString200NoSignature: For non-empty parameter values, verify the signature using the platform public key according to the Signature method

    Other considerations

    1. notify callback notification response Must return a clear result, the HTTP response code should be 200, and return the specified string: success (non-json format, does not contain other symbols of the plain string); if returns other results, 8 retries will be triggered. The retry interval is: 5s, 30s, 4m, 10m, 1h, 2h, 6h, 15h.