v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB
Payins

Search Payins

Get all Payins associated with the provided Organization ID.

post/api/payins/search

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"
      }
    }
  ]
}