Skip to main content

Initiating merchant payment with entire ussd flow

Initiates merchant payment with account picking on ussd flow. Result will be delivered asynchronously by calling user callback.

Request Body required
  • operationId string required

    merchant payment operation identifier

  • customerMsisdn +234'10 digits' or 234'10 digits' or 0'10 digits' or +0'10 digits' or '10 digits' required

    Payer msisdn

  • customerEmail valid email address according to "RFC 2822"

    Payer e-mail

  • merchantCode string required

    Merchant code

  • amount double required

    Amount to pay

  • executionMode object
  • mode string required

    Possible values: [WithoutWaitingForBank, WithBankResponseTimeout]

    Default value: WithBankResponseTimeout

    Execution mode for merchant payment response. When 'WithoutWaitingForBank', the response is returned when request reaches server. When 'WithBankResponseTimeout', the response is returned when result is known or timeout is reached.

  • millis number

    Default value: 30000

    Specified timeout, in milliseconds. Required for 'WithBankResponseTimeout' mode.

Responses

Operation order was accepted and is going to be processed.

Schema
  • recoveryShortcode string

    USSD string with recovery token, which can be used by user to dial in when USSD push won't be delivered. Recovery token feature is not enabled for all clients, so it can be null

Loading...