--- title: "Initiate bulk payouts" method: POST path: "/v2/payouts/bulk" tags: ["payouts"] --- # Initiate bulk payouts `POST /v2/payouts/bulk` ## Headers - `Content-Digest` string, string — SHA-256 or SHA-512 hash of the request body. - `Signature` string, string — Signature of the request according to [RFC-9421](https://datatracker.ietf.org/doc/rfc9421/). - `Signature-Input` string, string — Signature input according to [RFC-9421](https://datatracker.ietf.org/doc/rfc9421/). - `Accept-Signature` string, string — Expected signature algorithm of the response according to [RFC-9421](https://datatracker.ietf.org/doc/rfc9421/). - `Accept-Digest` string, string — Expected digest algorithm of the response according to [RFC-9421](https://datatracker.ietf.org/doc/rfc9421/). ## Request body - PayoutInitiationRequest[] - `payoutId` string, uuid, required — A UUIDv4 based unique ID for this payment. We require you to provide the unique ID for all initiated payments to ensure you can always reconcile all payments. Please store this ID in your system before initiating the payment with PawaPay. - `recipient` PayerOrRecipient, required — Details about the customer who is paying or receiving the payment. - `type` 'MMO', required — The type of account involved in the transaction. At the moment, only **MMO** is supported. - `accountDetails` AccountDetails, required - `phoneNumber` string, required — The phone number (MSISDN) of the customer paying or receiving payment. The format is described in [Wikipedia](https://en.wikipedia.org/wiki/MSISDN). Use [predict provider](/v2/api-reference/toolkit/predict-provider) to validate and sanitise the phone number. Phone number validation has following rules: * Only digits without whitespaces or any other separators or prefixes like '+'. * Should not start with zero. * Country code is mandatory. * Should not exceed or be less than the valid length of specified country. - `provider` string, required — The provider represents the mobile money operator or processor that can process payments. Find here a list of all the supported [providers](/v2/docs/providers). The [active configuration](/v2/api-reference/toolkit/active-configuration) endpoint provides the list of provider configured for your account. You can use the [predict provider](/v2/api-reference/toolkit/predict-provider) enpoint to predict the provider to use based on the phone number (MSISDN). - `clientReferenceId` string — A reference to an entity in your system that this payment relates to. For example, an invoice ID, customer ID etc. - `customerMessage` string — A short narration for the transaction. Depending on the 'provider', this message may be visible to the customer in the SMS receipt or within their transaction history. Defaults to your company name as registered on your PawaPay account trimmed to fit the length limitations. - `amount` string, required — The amount of the payment. Amount must follow below requirements or the request will be **rejected**: * Not all providers support decimals. Find which ones do from [providers](/v2/docs/providers) or dynamically using [active configuration](/v2/api-reference/toolkit/active-configuration) endpoint. * Transaction limits apply. Find them from the [Active Configuration](/v2/api-reference/toolkit/active-configuration) endpoint. * Leading zeroes are not permitted except where the value is less than 1. For any value less than one, one and only one leading zero must be supplied. - `currency` string, required — The currency in which the `amount` is specified. Format must be the ISO 4217 three character currency code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). Find the supported currencies for the [provider](/v2/docs/providers). The [active configuration](/v2/api-reference/toolkit/active-configuration) endpoint has all the providers configured for your account together with the supported currencies. - `metadata` TransactionMetadataRequestItem[] — A list of metadata that you can attach to the payment for providing additional context about the payment. For example, adding the channel from which the payment was initated, product ID or anything else that might help your operations team. Metadata will be included in: - In the dashboard on payment details pages - Financial statements as JSON object - Callbacks Metadata can be used when searching in the PawaPay Dashboard. Full value of the metadata field must be used for searches. Metadata will not be visible to the customer that is involved in this payment. Up to 10 metadata fields can be attached to a payment. - `additionalProperties` string — The metadata that you are attaching to the payment. For example `"orderId":"ORD-123456789"`. - `isPII` boolean — Indicates whether the field contains personally identifiable information. Used for compliance with GDPR or other relevant data privacy laws. ## Response `200` Request has been processed by PawaPay - PayoutCreationResponse[] - `payoutId` string, uuid, required — A UUIDv4 based unique ID for this payment. We require you to provide the unique ID for all initiated payments to ensure you can always reconcile all payments. Please store this ID in your system before initiating the payment with PawaPay. - `status` 'ACCEPTED' | 'REJECTED' | 'DUPLICATE_IGNORED', required — The initiation status of the payout: * `ACCEPTED` - The payout has been **accepted** by PawaPay for processing. * `REJECTED` - The payout request has been **rejected** by PawaPay. See failureReason for details. * `DUPLICATE_IGNORED` - The payout has been **ignored** as a duplicate of and already accepted payout. Deduplication is based on `payoutId`. - `created` string, date-time — The timestamp of when the payment was created in the PawaPay platform. Format defined by 'date-time' in RFC3339 section 5.6 from [IETF](https://tools.ietf.org/html/rfc3339#section-5.6) - `failureReason` PayoutInitiationFailureReason - `failureCode` 'NO_AUTHENTICATION' | 'AUTHENTICATION_ERROR' | 'AUTHORISATION_ERROR' | 'HTTP_SIGNATURE_ERROR' | 'INVALID_INPUT' | 'MISSING_PARAMETER' | 'UNSUPPORTED_PARAMETER' | 'INVALID_PARAMETER' | 'DUPLICATE_METADATA_FIELD' | 'PAYOUTS_NOT_ALLOWED' | 'INVALID_PHONE_NUMBER' | 'INVALID_AMOUNT' | 'PAWAPAY_WALLET_OUT_OF_FUNDS' | 'INVALID_CURRENCY' | 'INVALID_PROVIDER' | 'PROVIDER_TEMPORARILY_UNAVAILABLE' | 'UNKNOWN_ERROR' — Reason for the failure: * `NO_AUTHENTICATION` - The API token was not found in the request headers. * `AUTHENTICATION_ERROR` - The API token in the request headers is not valid. * `AUTHORISATION_ERROR` - The API Token in the request header is not authorised to make this request. * `HTTP_SIGNATURE_ERROR` - The signature you have passed with the request did not pass verification. * `INVALID_INPUT` - We were unable to parse the payload of the request. * `MISSING_PARAMETER` - A mandatory parameter was missing from the request body. * `UNSUPPORTED_PARAMETER` - An unsupported parameter was found in the request body. * `INVALID_PARAMETER` - A parameter had an incorrect value. * `DUPLICATE_METADATA_FIELD` - A duplicate field was found in payment metadata. * `PAYOUTS_NOT_ALLOWED` - Payouts are not enabled with the provider on your PawaPay account. * `INVALID_PHONE_NUMBER` - The phone number provided is in the wrong format. * `INVALID_AMOUNT` - The amount contains decimals which is not supported by the provider. * `PAWAPAY_WALLET_OUT_OF_FUNDS` - Your PawaPay wallet does not have the funds to complete this refund. * `INVALID_CURRENCY` - The currency is not supported by the provider. * `INVALID_PROVIDER` - The provider is not valid for this request. * `PROVIDER_TEMPORARILY_UNAVAILABLE` - The provider is not currently not able to accept payments. * `UNKNOWN_ERROR` - The provider is not valid for this request. - `failureMessage` string — A description of the failure ## Other responses - `400` — Request was rejected due to incompatibility with PawaPay API specification - `401` — Authentication failed. Make sure you have added the API token into the header. If using signatures, make sure they are valid. - `403` — Authorization failure. Please check your authentication token. - `500` — An unknown failure has occurred. --- [API](https://skmtc.net/pawapay/apis/pawapay-merchant-api-v2.md) · [All operations](https://skmtc.net/pawapay/apis/pawapay-merchant-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pawapay/pawapay-merchant-api-v2/versions/ce13c31e9746/schema)