Payins

Search Payins

Changed on Nov 3, 2026

Get all Payins associated with the provided Organization ID.

post/api/payins/search

Request

Base URL
https://api.muralpay.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/muralpay/apis/mural-api/docs/api/payins/search/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

limitnumber

nextIdstring uuid

payinBatchIdstring uuid

Filter payins by PayinBatch ID.

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Response

Returned Payins

nextIdstring uuid

totalnumber required

Example response

{
  "results": [
    {
      "payinStatus": {
        "senderMetadata": {
          "senderAccountNumber": "987654321",
          "senderAccountType": "ahorros",
          "senderBankCode": "1007",
          "senderId": "1234567890",
          "senderIdType": "cc",
          "senderName": "Juan Perez"
        }
      },
      "sourceAmount": {
        "exponent": 2,
        "value": "2500"
      },
      "settlementDetails": {
        "amount": {
          "exponent": 2,
          "value": "2500"
        }
      },
      "fees": {
        "feeTotal": {
          "exponent": 2,
          "value": "2500"
        },
        "itemizedFees": {
          "developerFee": {
            "exponent": 2,
            "value": "2500"
          },
          "fixedTransactionFee": {
            "exponent": 2,
            "value": "2500"
          },
          "variableFee": {
            "exponent": 2,
            "value": "2500"
          }
        }
      },
      "payinInstructions": {
        "descriptionToPayer": "Order #001 payment",
        "keyValue": "@CBF0JHIDU"
      }
    }
  ]
}

Changes

Nov 3, 202665aadbefe527 Revision changes
- breaking
  added to the /// response property oneOf list for the response status
- warning
  added the new SignedAgreementRequiredException enum value to the response property for the response status
- warning
  added the new TRON enum value to the ////////// response property for the response status
- info
  added the non-success response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  removed the SOLANA enum value from the /////// response property for the response status
- info
  removed the SOLANA enum value from the /////// response property for the response status
- info
  removed the SOLANA enum value from the /////// response property for the response status
- info
  removed the SOLANA enum value from the /////// response property for the response status
- info
  removed the SOLANA enum value from the /////// response property for the response status
- info
  removed the SOLANA enum value from the ///// response property for the response status

Operation history