---
updatedAt: 2026-05-28T11:38:46.000Z
agentTools:
  projectIndex: https://developer.sivo.com/llms.txt
---

# Create a payment

Create a payment

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Banking",
    "description": "SIVO public Api REST",
    "version": "0.0.1"
  },
  "x-amazon-apigateway-api-key-source": "AUTHORIZER",
  "servers": [
    {
      "url": "https://dev.sivo.com/v1",
      "description": "Sandbox server (user test data)"
    }
  ],
  "paths": {
    "/banking/payments": {
      "post": {
        "summary": "Create a payment",
        "description": "Create a payment",
        "operationId": "postBankingPayment",
        "tags": [
          "Payments"
        ],
        "requestBody": {
          "description": "Create a payment",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/paymentCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment"
                }
              }
            }
          },
          "405": {
            "description": "Invalid input"
          }
        },
        "security": [
          {
            "prod-sandbox-sivo-api-authorizer": [
              "aws.cognito.signin.user.admin"
            ]
          }
        ],
        "x-amazon-apigateway-integration": {
          "httpMethod": "POST",
          "type": "AWS_PROXY",
          "uri": "arn:aws:apigateway:us-east-2:lambda:path/2015-03-31/functions/${Token[TOKEN.2318]}:Alias/invocations"
        }
      }
    }
  },
  "components": {
    "schemas": {
      "moneyAmount": {
        "type": "integer",
        "description": "See [Money](https://developer.sivo.com/reference/money) for details"
      },
      "uuid": {
        "type": "string",
        "description": "A universal identifier (all lowercase)",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "currencyIso4217": {
        "type": "string",
        "description": "A currency identifier in ISO-4217 format",
        "pattern": "^[A-Z]{3}$"
      },
      "text": {
        "type": "string",
        "minLength": 1
      },
      "dateIso8601": {
        "type": "string",
        "description": "See [Dates and Times](https://developer.sivo.com/reference/dates-and-times) for details",
        "format": "date"
      },
      "paymentCreate": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "paymentDate": {
            "$ref": "#/components/schemas/dateIso8601"
          },
          "paymentType": {
            "$ref": "#/components/schemas/paymentTypeonin"
          },
          "beneficiaryId": {
            "$ref": "#/components/schemas/uuid"
          },
          "reason": {
            "$ref": "#/components/schemas/text"
          },
          "reference": {
            "$ref": "#/components/schemas/text"
          },
          "conversionId": {
            "$ref": "#/components/schemas/uuid"
          },
          "uniqueRequestId": {
            "$ref": "#/components/schemas/uuid"
          },
          "ultimateBeneficiaryName": {
            "$ref": "#/components/schemas/text"
          },
          "purposeCode": {
            "$ref": "#/components/schemas/text"
          },
          "chargeType": {
            "$ref": "#/components/schemas/chargeTypen5kk"
          },
          "feeAmount": {
            "$ref": "#/components/schemas/moneyAmount"
          },
          "feeCurrency": {
            "$ref": "#/components/schemas/currencyIso4217"
          },
          "amount": {
            "$ref": "#/components/schemas/moneyAmount"
          },
          "currency": {
            "$ref": "#/components/schemas/currencyIso4217"
          }
        },
        "required": [
          "amount",
          "beneficiaryId",
          "currency",
          "reason",
          "reference"
        ]
      },
      "chargeTypen5kk": {
        "type": "string",
        "enum": [
          "ours",
          "shared"
        ]
      },
      "paymentTypeonin": {
        "type": "string",
        "enum": [
          "priority",
          "regular"
        ]
      },
      "payment": {
        "type": "object",
        "properties": {
          "date": {
            "$ref": "#/components/schemas/dateIso8601",
            "description": "Date of the payment. See [Dates and Times](https://developer.sivo.com/reference/dates-and-times) for details"
          },
          "amount": {
            "$ref": "#/components/schemas/moneyAmount",
            "description": "Amount paid. See [Money](https://developer.sivo.com/reference/money) for details"
          },
          "type": {
            "$ref": "#/components/schemas/paymentType",
            "description": "Type of payment (e.g. principal, interest, fee)"
          }
        },
        "required": [
          "date",
          "amount",
          "type"
        ],
        "additionalProperties": false
      },
      "paymentType": {
        "type": "string",
        "enum": [
          "principal",
          "interest",
          "fee"
        ]
      }
    },
    "securitySchemes": {
      "prod-sandbox-sivo-api-authorizer": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-amazon-apigateway-authtype": "cognito_user_pools",
        "x-amazon-apigateway-authorizer": {
          "type": "cognito_user_pools",
          "providerARNs": [
            "${Token[TOKEN.1762]}"
          ]
        }
      }
    }
  },
  "x-amazon-apigateway-minimum-compression-size": 0
}
```