---
updatedAt: 2025-05-19T21:40:59.000Z
agentTools:
  projectIndex: https://convera.readme.io/llms.txt
---

# Add Payment to Batch

The basic request to add a payment to an existing, uncommitted batch. This request will be returned immediately to indicate a successfully or unsuccessfully received payment. Payment body validations are performed asynchronously and results are returned through webhook or retrieved through a [Get Payment by ID](https://convera.readme.io/reference/payments_getpayment)  request.

A successfully committed payment that passes validation has the status of `Created` and can be committed into a Payment Order.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.1.0",
    "title": "Payments API"
  },
  "x-explorer-enabled": false,
  "servers": [
    {
      "url": "https://masspaysandbox.api.convera.com/MassPayments",
      "description": "Staging"
    },
    {
      "url": "https://api.convera.com/v1/masspayments",
      "description": "Production"
    }
  ],
  "paths": {
    "/customers/{customerId}/batches/{batchId}/payments": {
      "put": {
        "tags": [
          "Payment Resource"
        ],
        "summary": "Add Payment to Batch",
        "operationId": "Payments_PutBatchPayments",
        "parameters": [
          {
            "name": "customerId",
            "in": "path",
            "description": "customerId",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "batchId",
            "in": "path",
            "description": "batchId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CommitBatchPaymentsRequestData"
              }
            }
          },
          "description": "requestData",
          "required": true
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CommitPaymentsResultData"
                }
              }
            }
          },
          "400": {
            "description": "BadRequest",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "RemittanceReferenceData": {
        "type": "object",
        "properties": {
          "ref": {
            "type": "string"
          }
        }
      },
      "ThirdPartyRemitterData": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "versionedOn": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "businessName": {
            "type": "string"
          },
          "address": {
            "$ref": "#/components/schemas/AddressData"
          },
          "email": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string"
          },
          "countryOfNationality": {
            "type": "string"
          },
          "identificationType": {
            "type": "string"
          },
          "identification": {
            "type": "string"
          },
          "industry": {
            "type": "string"
          },
          "bankAccount": {
            "$ref": "#/components/schemas/BankAccountDetailsData"
          }
        }
      },
      "AddressData": {
        "type": "object",
        "properties": {
          "line1": {
            "type": "string"
          },
          "line2": {
            "type": "string"
          },
          "line3": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "stateOrProv": {
            "type": "string"
          },
          "zipOrPostal": {
            "type": "string"
          },
          "countryCode": {
            "type": "string"
          }
        }
      },
      "AuthorizedUsersData": {
        "type": "object",
        "properties": {
          "User1": {
            "type": "string"
          },
          "User2": {
            "type": "string"
          },
          "User3": {
            "type": "string"
          }
        }
      },
      "BankAccountDetailsData": {
        "type": "object",
        "properties": {
          "accountNumber": {
            "type": "string"
          },
          "accountCurrency": {
            "type": "string"
          },
          "bankCode": {
            "type": "string"
          },
          "bankRoutingCode": {
            "type": "string"
          }
        }
      },
      "OriginatingFI": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "versionedOn": {
            "type": "string"
          },
          "accountNumber": {
            "type": "string"
          },
          "accountType": {
            "type": "string"
          },
          "bankName": {
            "type": "string"
          },
          "bankCode": {
            "type": "string"
          },
          "address": {
            "$ref": "#/components/schemas/AddressData"
          },
          "accountCurrency": {
            "type": "string"
          },
          "bankRoutingCode": {
            "type": "string"
          }
        }
      },
      "IntermediaryBankData": {
        "type": "object",
        "properties": {
          "bankName": {
            "type": "string"
          },
          "bankCode": {
            "type": "string"
          },
          "accountNumber": {
            "type": "string"
          },
          "bankBranchCode": {
            "type": "string"
          },
          "address": {
            "$ref": "#/components/schemas/AddressData"
          }
        }
      },
      "BeneficiaryData": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "versionedOn": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "occupation": {
            "type": "string"
          },
          "countryofNationality": {
            "type": "string"
          },
          "identificationDocumentType": {
            "type": "string"
          },
          "identificationDocumentNumber": {
            "type": "string"
          },
          "identificationDocumentCountry": {
            "type": "string"
          },
          "alias": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "taxId": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "middleName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string"
          },
          "cellNumber": {
            "type": "string"
          },
          "dateOfBirth": {
            "type": "string"
          },
          "gender": {
            "type": "string"
          },
          "businessName": {
            "type": "string"
          },
          "businessRegistrationNumber": {
            "type": "string"
          },
          "businessRegistrationCountry": {
            "type": "string"
          },
          "businessRegistrationStateProv": {
            "type": "string"
          },
          "industry": {
            "type": "string"
          },
          "address": {
            "$ref": "#/components/schemas/AddressData"
          },
          "authorizedUsers": {
            "$ref": "#/components/schemas/AuthorizedUsersData"
          }
        }
      },
      "BeneficiaryBankAccountData": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "versionedOn": {
            "type": "string"
          },
          "accountNumber": {
            "type": "string"
          },
          "accountType": {
            "type": "string"
          },
          "bankName": {
            "type": "string"
          },
          "bankBranchName": {
            "type": "string"
          },
          "bankCode": {
            "type": "string"
          },
          "bankBranchCode": {
            "type": "string"
          },
          "address": {
            "$ref": "#/components/schemas/AddressData"
          },
          "intermediaryBank": {
            "$ref": "#/components/schemas/IntermediaryBankData"
          }
        }
      },
      "CommitPaymentsResultData": {
        "type": "object",
        "properties": {
          "receivedPayments": {
            "format": "int32",
            "type": "integer"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "CommitBatchPaymentsRequestData": {
        "type": "object",
        "properties": {
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BatchedPaymentData"
            }
          }
        }
      },
      "BatchedPaymentData": {
        "required": [
          "id",
          "iban"
        ],
        "type": "object",
        "properties": {
          "partnerReference": {
            "type": "string"
          },
          "paymentMethod": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "paymentReference": {
            "type": "string"
          },
          "amount": {
            "format": "int64",
            "type": "integer"
          },
          "currencyCode": {
            "type": "string"
          },
          "settlementCurrencyCode": {
            "type": "string"
          },
          "isFixedAmountInSettlementCurrency": {
            "type": "string"
          },
          "isDoddFrank": {
            "type": "boolean"
          },
          "chargeType": {
            "type": "string"
          },
          "valueDate": {
            "type": "string"
          },
          "uetr": {
            "type": "string"
          },
          "beneficiary": {
            "$ref": "#/components/schemas/BeneficiaryData"
          },
          "bankAccount": {
            "$ref": "#/components/schemas/BeneficiaryBankAccountData"
          },
          "iban": {
            "type": "string",
            "description": "International Bank Account Number - mandatory for VOP (Validation of Payee)"
          },
          "purposeOfPayment": {
            "type": "string"
          },
          "purposeOfPaymentCode": {
            "type": "string"
          },
          "instructionForBank": {
            "type": "string"
          },
          "instructionCodeForBank": {
            "type": "string"
          },
          "remittanceType": {
            "type": "string"
          },
          "remittanceData": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RemittanceReferenceData"
            }
          },
          "thirdPartyRemitter": {
            "$ref": "#/components/schemas/ThirdPartyRemitterData"
          },
          "originatingFI": {
            "$ref": "#/components/schemas/OriginatingFI"
          }
        }
      }
    }
  }
}
```