--- title: "Check split payment status" method: GET path: "/v2/split-payments/{splitPaymentId}" tags: ["split-payments"] --- # Check split payment status `GET /v2/split-payments/{splitPaymentId}` ## Request - Base URL: `https://api.sandbox.pawapay.io` - URL: `https://api.sandbox.pawapay.io/v2/split-payments/{splitPaymentId}` - Auth: HTTP bearer ## Path parameters - `splitPaymentId` string, uuid, required ## Response `200` Request has been processed by PawaPay. - SplitPaymentSearchResult - `status` 'FOUND' | 'NOT_FOUND', required: The result of this operation. - `FOUND` - The payment was found in PawaPay. - `NOT_FOUND` - The payment was not found in PawaPay. - `data` SplitPayment - `splitPaymentId` string, uuid, required: The unique ID for this payment in PawaPay as specified by you during initiation. - `status` 'ACCEPTED' | 'PROCESSING' | 'IN_RECONCILIATION' | 'DEPOSIT_COMPLETED' | 'COMPLETED' | 'ENQUEUED' | 'PAYOUT_FAILED' | 'FAILED', required: Possible split payment statuses: * `ACCEPTED` - The split payment has been **accepted** by PawaPay for processing. * `PROCESSING` - The split payment is being processed. * `IN_RECONCILIATION` - The split payment is being reconciled to determine its final state. * `DEPOSIT_COMPLETED` - The collection leg has completed and the split payout is still in progress. * `ENQUEUED` - The split payout leg has been enqueued for later processing. * `COMPLETED` - The collection and the split payout have both completed successfully. This is a **final status.** * `PAYOUT_FAILED` - The collection completed, but the split payout failed. This is a **final status.** See `splits[].failureReason` for details. * `FAILED` - The collection failed. This is a **final status.** See `failureReason` for details. - `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. - `country` string, required: The country in which the payment was initiated. Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements). - `payer` 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. - `created` string, date-time, required: 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) - `providerTransactionId` string: The unique ID for this payment assigned by the provider. The customer would see this ID on their SMS receipt and transaction history. - `splits` SplitPayout[], required - `payoutId` string, uuid, required: The unique ID for this payment in PawaPay as specified by you during initiation. - `status` 'ACCEPTED' | 'COMPLETED' | 'PROCESSING' | 'FAILED' | 'ENQUEUED', required: Possible split payout statuses: * `ACCEPTED` - The split payout has been accepted by PawaPay for processing. * `ENQUEUED` - The split payout has been accepted, but has been enqueued for processing later. * `PROCESSING` - The split payout has been submitted to the provider and is being processed. * `COMPLETED` - The split payout has been successfully processed. This is a **final status.** * `FAILED` - The split payout has been processed, but failed. This is a **final status.** - `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. - `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). - `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. - `providerTransactionId` string: The unique ID for this payment assigned by the provider. The customer would see this ID on their SMS receipt and transaction history. - `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` SplitPaymentPayoutFailureReason: The reason of the failure in case the split payout leg is in `FAILED` status. - `failureCode` 'PAWAPAY_WALLET_OUT_OF_FUNDS' | 'RECIPIENT_NOT_FOUND' | 'WALLET_LIMIT_REACHED' | 'MANUALLY_CANCELLED' | 'UNSPECIFIED_FAILURE', required: Possible split payout failure codes: * `PAWAPAY_WALLET_OUT_OF_FUNDS` - Your PawaPay wallet does not have enough funds to complete this split payout. * `RECIPIENT_NOT_FOUND` - The recipient does not have an account with the provider or it is not active. * `WALLET_LIMIT_REACHED` - The recipient wallet has reached a transaction or wallet limit. * `MANUALLY_CANCELLED` - The split payout was cancelled manually after being enqueued. * `UNSPECIFIED_FAILURE` - The provider confirmed the payout failed, but did not provide additional details. - `failureMessage` string: Description of the reason for this failure. - `metadata` TransactionMetadataResponse: The metadata that was provided in the original initation request in a JSON object format. - `additionalProperties` string: Each passed in metadata field will be a property of the metadata JSON object. - `failureReason` SplitPaymentDepositFailureReason: The reason of the failure in case the collection leg is in `FAILED` status. - `failureCode` 'NOT_ENOUGH_FUNDS' | 'WALLET_LIMIT_REACHED' | 'PAYER_NOT_FOUND' | 'PAYMENT_NOT_APPROVED' | 'UNSPECIFIED_FAILURE' | 'INSUFFICIENT_BALANCE' | 'PAYMENT_IN_PROGRESS', required: Possible split payment collection failure codes: * `NOT_ENOUGH_FUNDS` - The payer does not have enough funds to complete the payment. * `WALLET_LIMIT_REACHED` - The payer wallet has reached a transaction or wallet limit. * `PAYER_NOT_FOUND` - The phone number does not have a mobile money account with the provider or does not belong to the provider. * `PAYMENT_NOT_APPROVED` - The payer did not approve the payment. * `UNSPECIFIED_FAILURE` - The provider confirmed the payment failed, but did not provide additional details. * `INSUFFICIENT_BALANCE` - The payer has insufficient balance for this payment. * `PAYMENT_IN_PROGRESS` - The payer already has a payment in progress with this provider. - `failureMessage` string: Description of the reason for this failure. ## Changes - **2026-11-03** `4556d2ec2141`: 1 info - endpoint added [Operation history](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2/changes/v2/split-payments/:splitPaymentId/get.md) --- [API](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2.md) - [All operations](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/pawapay/apis/pawapay-merchant-api-v2/revisions/4556d2ec2141?raw)