Workforce Payments APIs
  • Introduction
  • Real-Life Scenarios
  • API Reference
    • API Essentials
    • Payment Status
    • Environments
    • Authentication API
    • Wallets Management
      • Open A Wallet
      • Get Wallets List
      • Get Wallet Details
      • Get Wallet Statements
    • Groups Management
      • Create A Payment Group
      • Update A Payment Group
      • Get Payment Group Details
      • Get Payment Groups List
      • Lock Payment Group
      • UnLock Payment Group
      • Delete Payment Group
    • Beneficiaries Management
      • Get Schema Information
      • Create A Beneficiary
      • Update Beneficiary Details
      • Get Beneficiary Details
      • Get Beneficiaries List
      • Bulk Import Beneficiary
      • Bulk Import Beneficiary Status
      • Bulk Validate Beneficiary
    • Payment Management
      • Create Payment Instruction
      • Update Payment Instructions
      • Get Payment Details
      • Get Payments List
      • Approve Payment Instructions
      • UnApprove Payment Instructions
      • Execute Payment Instructions
      • Bulk Import Payment Instructions
      • Bulk Import Payment Instructions Status
    • Webhooks Notifications
Powered by GitBook

© All rights reserved to papaya global 2024

On this page
  1. API Reference

Payment Status

PreviousAPI EssentialsNextEnvironments

Last updated 1 year ago

With Papaya Global REST API, you can gain transparency and efficiency in tracking payment status. Our dedicated endpoints allow you to retrieve real-time payment status information, making it effortless to process transactions, verify payment outcomes, or reconcile accounts.

Payment Cycle

As you initiate a payment, it goes through various statuses, with each step associated with a particular status and following a looped pattern.

Payment Status
Description

PENDING

The payment is currently awaiting execution until it is approved or the execution date is reached.

PROCESSING

Once the transaction is executed, it enters the processing phase, marking an intermediate state before proceeding to any final states.

PROCESSED

Payment instructions have been forwarded to the partnered bank/service for completion. The transaction is either in progress at the bank or awaiting confirmation of its final status (SUCCESS/FAILURE).

COMPLETED (Final State)

The partnered bank successfully completed the transaction, and the amount has been transferred to the customer's account.

FAILED (Final State)

The payment could not be completed because of an error or decline. Keep in mind that this issue may arise due to reasons like insufficient funds, incorrect account or beneficiary information, and more. To prevent such occurrences, consider utilizing the Low Balance Alert Webhook and Verification APIs for better transaction management.

PARTIAL

Split payments (such as Yen > 1M) mark a partial completion of the multiple transactions within the payment.

CANCELLED (Final State)

The user or system has canceled or deleted the payment prior to processing. This transition occurs only when the payout is in a PENDING state.

Error Handling: Should there be any issues retrieving the payment status, our API will return appropriate error codes and messages, enabling you to handle exceptions in your application accordingly.

Please ensure your systems handle all payment statuses for a smooth user experience. Subsequent sections of this documentation provide detailed information on each status type, webhook configuration, and error codes.