Sign in

v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB
Payins

Create a Payin Intent

Creates a new Payin Intent.

post/api/payins/payin

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.

payinRail'ACH' | 'WIRE' | 'SEPA' | 'MXN_SPEI' | 'BRL_PIX' | 'ARS_CVU' | 'COP_PSE' | 'COP_BREB' | 'BLOCKCHAIN' required

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