Payins

Create a Payin Intent

Changed on Nov 3, 2026

Creates a new Payin Intent.

post/api/payins/payin

Request

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

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Request body

destinationMuralAccountIdstring uuid required

The mural account that you will receive the funds in

Example request

{
  "payinDetails": {
    "amount": {
      "currencySymbol": "COP",
      "value": "1230000"
    },
    "descriptionToPayee": "Order #001",
    "descriptionToPayer": "Order #001 payment",
    "payerName": "Fernando Alonso"
  }
}

Response

Created Payin Intent

idstring uuid required

destinationAccountIdstring uuid required

The ID of the mural account that the payin is being sent to.

The payment rail used for this payin.

exchangeRatenumber

The exchange rate used for this payin. Multiply the fiat payin amount by this rate to get the equivalent token amount. Only present for non-USD payins.

createdAtstring date-time required

The date and time the payin was created.

updatedAtstring date-time required

The date and time the payin was last updated.

payinBatchIdstring uuid nullable

If this payin was created as part of a batch payin, the ID of the PayinBatch.

Example response

{
  "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 body oneOf list for the response status
- breaking
  the response's body type changed from object to no type for status
- breaking
  added to the response property oneOf list for the response status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  added the new PayinMinimumNotMetError 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
  the request property default value 86400 was added
- info
  the request property default value 86400 was added
- info
  added the new TRON enum value to the request property /////
- info
  added response discriminator 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