# Create a new invoice payment

Endpoint: POST /invoice-payments
Version: 1.37
Security: bearerAuth

## Request fields (application/json):

  - `generatedInvoiceId` (integer, required)
    Generated Invoice identifier
    Example: 1

  - `thirdPartyPaymentStatus` (string)
    Invoice payment status. Not applicable for manual payments
    Enum: "NEW", "CREATED", "PENDING_CUSTOMER_APPROVAL", "PENDING_SUBMISSION", "SUBMITTED", "CONFIRMED", "PAID_OUT", "CANCELLED", "FAILED", "FAILED_RETRYING", "CHARGED_BACK", "CUSTOMER_APPROVAL_GRANTED", "CUSTOMER_APPROVAL_DENIED", "CHARGEBACK_CANCELLED", "LATE_FAILURE_SETTLED", "CHARGEBACK_SETTLED", "SURCHARGE_FEE_DEBITED", "RESUBMISSION_REQUESTED", "UNSUPPORTED_PAYMENT_TYPE", "UNAUTHORISED_PAYMENT_TYPE", "CUSTOMER_APPROVAL_MISSING", "SURCHARGE_FEE_CREDITED", "MANUALLY_PAID", "UNSENT", "REFUNDED", "PARTIALLY_REFUNDED", "REFUND_PENDING"

  - `amountInMajorCurrency` (number, required)
    Amount in major currency (e.g pounds/dollars/euros)
    Example: 10.5

  - `description` (string, required)
    Payment description

  - `paymentMethod` (string, required)
    Payment method
    Enum: "CHEQUE", "DIRECT_DEBIT", "CANCELLED_DD", "CANCELLED_CARD", "CREDIT_CARD", "PAYPAL", "BACS", "POST_OFFICE_PAYMENT_CARD", "EZYPAY", "GO_CARDLESS", "GC_INSTANT_BANK_PAYMENTS", "STRIPE", "STRIPE_CARD", "STRIPE_DD", "FINASTRA", "FAST_PAY", "OTHER"

## Response 200 fields (application/json):

  - `id` (integer)
    Invoice Payment identifier
    Example: 1

  - `generatedInvoiceId` (integer, required)
    Generated Invoice identifier
    Example: 1

  - `thirdPartyPaymentStatus` (string)
    Invoice payment status. Not applicable for manual payments
    Enum: "NEW", "CREATED", "PENDING_CUSTOMER_APPROVAL", "PENDING_SUBMISSION", "SUBMITTED", "CONFIRMED", "PAID_OUT", "CANCELLED", "FAILED", "FAILED_RETRYING", "CHARGED_BACK", "CUSTOMER_APPROVAL_GRANTED", "CUSTOMER_APPROVAL_DENIED", "CHARGEBACK_CANCELLED", "LATE_FAILURE_SETTLED", "CHARGEBACK_SETTLED", "SURCHARGE_FEE_DEBITED", "RESUBMISSION_REQUESTED", "UNSUPPORTED_PAYMENT_TYPE", "UNAUTHORISED_PAYMENT_TYPE", "CUSTOMER_APPROVAL_MISSING", "SURCHARGE_FEE_CREDITED", "MANUALLY_PAID", "UNSENT", "REFUNDED", "PARTIALLY_REFUNDED", "REFUND_PENDING"

  - `amountInMajorCurrency` (number, required)
    Amount in major currency (e.g pounds/dollars/euros)
    Example: 10.5

  - `currencyId` (integer)
    Currency Id
    Example: 1

  - `description` (string, required)
    Payment description

  - `metaData` (string)
    Meta data

  - `errorInfo` (string)
    Error information from payment provider

  - `paymentMethod` (string, required)
    Payment method
    Enum: "CHEQUE", "DIRECT_DEBIT", "CANCELLED_DD", "CANCELLED_CARD", "CREDIT_CARD", "PAYPAL", "BACS", "POST_OFFICE_PAYMENT_CARD", "EZYPAY", "GO_CARDLESS", "GC_INSTANT_BANK_PAYMENTS", "STRIPE", "STRIPE_CARD", "STRIPE_DD", "FINASTRA", "FAST_PAY", "OTHER"

  - `paymentDate` (string)
    When payment was made

  - `customerPaymentType` (string)
    Type of payment
    Enum: "CUSTOMER", "NORMAL_INVOICE", "ADHOC_INVOICE", "ADJUSTMENT"

  - `customerPaymentId` (integer)
    Customer payment id
    Example: 1

## Response 201 fields (application/json):

  - `id` (integer)
    Invoice Payment identifier
    Example: 1

  - `generatedInvoiceId` (integer, required)
    Generated Invoice identifier
    Example: 1

  - `thirdPartyPaymentStatus` (string)
    Invoice payment status. Not applicable for manual payments
    Enum: "NEW", "CREATED", "PENDING_CUSTOMER_APPROVAL", "PENDING_SUBMISSION", "SUBMITTED", "CONFIRMED", "PAID_OUT", "CANCELLED", "FAILED", "FAILED_RETRYING", "CHARGED_BACK", "CUSTOMER_APPROVAL_GRANTED", "CUSTOMER_APPROVAL_DENIED", "CHARGEBACK_CANCELLED", "LATE_FAILURE_SETTLED", "CHARGEBACK_SETTLED", "SURCHARGE_FEE_DEBITED", "RESUBMISSION_REQUESTED", "UNSUPPORTED_PAYMENT_TYPE", "UNAUTHORISED_PAYMENT_TYPE", "CUSTOMER_APPROVAL_MISSING", "SURCHARGE_FEE_CREDITED", "MANUALLY_PAID", "UNSENT", "REFUNDED", "PARTIALLY_REFUNDED", "REFUND_PENDING"

  - `amountInMajorCurrency` (number, required)
    Amount in major currency (e.g pounds/dollars/euros)
    Example: 10.5

  - `currencyId` (integer)
    Currency Id
    Example: 1

  - `description` (string, required)
    Payment description

  - `metaData` (string)
    Meta data

  - `errorInfo` (string)
    Error information from payment provider

  - `paymentMethod` (string, required)
    Payment method
    Enum: "CHEQUE", "DIRECT_DEBIT", "CANCELLED_DD", "CANCELLED_CARD", "CREDIT_CARD", "PAYPAL", "BACS", "POST_OFFICE_PAYMENT_CARD", "EZYPAY", "GO_CARDLESS", "GC_INSTANT_BANK_PAYMENTS", "STRIPE", "STRIPE_CARD", "STRIPE_DD", "FINASTRA", "FAST_PAY", "OTHER"

  - `paymentDate` (string)
    When payment was made

  - `customerPaymentType` (string)
    Type of payment
    Enum: "CUSTOMER", "NORMAL_INVOICE", "ADHOC_INVOICE", "ADJUSTMENT"

  - `customerPaymentId` (integer)
    Customer payment id
    Example: 1


## Response 400 fields

## Response 401 fields

## Response 403 fields