Search payouts by merchant reference

curl -G https://api.payos.money/api/v1/payout/search \
     -d merchantIds=string \
     -d merchantReference=merchantReference

[
  {
    "currentState": "string",
    "previousStates": [
      "string"
    ],
    "processor": "string",
    "merchantName": "string",
    "transactionId": "string",
    "amount": 1.1,
    "transactionType": "string",
    "paymentMethodId": "string",
    "currency": "string",
    "merchantReference": "string",
    "transactionStates": [
      {
        "pendingState": {
          "state": "string",
          "transitionedAt": "string",
          "transactionId": "string"
        },
        "balancePendingState": {
          "state": "string",
          "transitionedAt": "string"
        },
        "balanceVerifiedState": {
          "state": "string",
          "transitionedAt": "string"
        },
        "authRequiredState": {
          "state": "string",
          "transitionedAt": "string",
          "authMethodType": "redirect",
          "redirect": {
            "url": "string"
          }
        },
        "errorState": {
          "state": "string",
          "transitionedAt": "string",
          "message": "string",
          "code": "configurationError",
          "connectorFailureCode": "string",
          "connectorFailureMessage": "string"
        },
        "failedState": {
          "state": "string",
          "transitionedAt": "string",
          "message": "string",
          "code": "3dsDeclinedByUser",
          "connectorFailureCode": "string",
          "connectorFailureMessage": "string"
        },
        "successState": {
          "state": "string",
          "transitionedAt": "string"
        },
        "routedState": {
          "state": "string",
          "transitionedAt": "string",
          "message": "string",
          "processorDisplayName": "string",
          "applicableRules": [
            {
              "ruleId": "string",
              "ruleName": "string"
            }
          ],
          "card": {
            "encryptedCardNumber": "string",
            "cardExpiryMonth": "string",
            "cardExpiryYear": "string",
            "encryptedCardCvv": "string",
            "cardHolderName": "string",
            "payerEmail": "string",
            "cardBrand": "string",
            "cardBin": "string",
            "cardLastFour": "string",
            "shouldSaveCard": true
          },
          "ieft": {},
          "directCharge": {
            "payerBank": "string",
            "payerAccountNumber": "string"
          },
          "bankTransfer": {
            "transactionReference": "string",
            "payerFullName": "string",
            "phoneNumber": "string",
            "bankCountry": "string"
          },
          "mobileMoney": {
            "provider": "airtel",
            "payerMobileNumber": "string",
            "payerFullName": "string",
            "providerCategoryKey": "string"
          }
        },
        "receivedState": {
          "state": "string",
          "transitionedAt": "string",
          "message": "string"
        },
        "completedState": {
          "state": "string",
          "transitionedAt": "string",
          "message": "string"
        },
        "authExecutingState": {
          "state": "string",
          "transitionedAt": "string",
          "message": "string"
        },
        "cancelledState": {
          "state": "string",
          "transitionedAt": "string"
        },
        "expiredState": {
          "state": "string",
          "transitionedAt": "string"
        },
        "settledState": {
          "state": "string",
          "transitionedAt": "string",
          "settledAt": "string",
          "settlementId": "string"
        }
      }
    ],
    "paymentAttributes": {},
    "identifiers": {},
    "paymentInstrument": {
      "encryptedCardNumber": "string",
      "encryptedCardCvv": "string",
      "cardExpiryYear": "string",
      "cardExpiryMonth": "string",
      "cardHolderName": "string",
      "payerEmail": "string",
      "bin": "string",
      "lastFour": "string",
      "eci": "string",
      "secure3d": {
        "decision": "string",
        "decisionReason": "string"
      },
      "retrievalReferenceNumber": "string",
      "issuer": {
        "country": "string"
      }
    },
    "processorReference": "string",
    "financialTransactionReference": "string",
    "currentAttemptId": "string",
    "batchPayoutId": "string"
  }
]

Retrieves payout transactions matching a merchant reference

Query parameters

merchantIdslist of stringsRequired

Comma-separated list of merchant IDs to search within

merchantReferencestringRequired

Merchant reference to search for

Response

Payouts retrieved successfully

currentStatestring

Current transaction state

previousStateslist of strings

Array of previous transaction states

processorstring

Payment processor used for the transaction

merchantNamestring

Merchant name

transactionIdstring

Unique transaction identifier

amountdouble

Transaction amount

transactionTypestring

Transaction type

paymentMethodIdstring

Payment method identifier

currencystring

Transaction currency

merchantReferencestring

Merchant reference

transactionStateslist of objects

Detailed transaction state history

paymentAttributesmap from strings to strings

Payment-specific attributes and metadata

identifiersmap from strings to strings

Additional transaction identifiers

paymentInstrumentobject

Card payment instrument details

processorReferencestring

Payment processor reference

financialTransactionReferencestring

Financial transaction reference from the processor

currentAttemptIdstring

Current attempt identifier

batchPayoutIdstring

Batch payout identifier, if the transaction is part of a batch payout

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error