| Name | Type | Description | Notes |
|---|---|---|---|
| originator_conversation_id | str | This is a unique string you specify for every API request you simulate. If not provided, the system may generate one automatically. | [optional] |
| initiator_name | str | This is an API user created by the Business Administrator of the M-PESA Bulk disbursement account that is active and authorised to initiate B2C transactions via API. | |
| security_credential | str | This is the value obtained after encrypting the API initiator password. The password on Sandbox has been provisioned on the simulator. However, on production the password is created when the user is being created on the M-PESA organisation portal. | |
| command_id | str | This is a unique command that specifies B2C transaction type: - SalaryPayment: This supports sending money to both registered and unregistered M-Pesa customers. - BusinessPayment: This is a normal business to customer payment, supports only M-PESA registered customers. - PromotionPayment: This is a promotional payment to customers. The M-PESA notification message is a congratulatory message. Supports only M-PESA registered customers. | |
| amount | int | The amount of money being sent to the customer (whole numbers only). | |
| party_a | int | This is the B2C organisation shortcode from which the money is sent from (5-7 digits). | |
| party_b | int | This is the customer mobile number to receive the amount. The number should have the country code (254) without the plus sign. | |
| remarks | str | Any additional information to be associated with the transaction. | |
| queue_time_out_url | str | This is the URL to be specified in your request that will be used by API Proxy to send notification in case the payment request is timed out while awaiting processing in the queue. Optional - if not provided, no timeout notifications will be sent. | [optional] |
| result_url | str | This is the URL to be specified in your request that will be used by M-PESA to send notification upon processing of the payment request. Optional - if not provided, no result notifications will be sent. | [optional] |
| occasion | str | Any additional information to be associated with the transaction (optional). | [optional] |