---
title: "Creates an InvoicePayment"
method: POST
path: "/InvoicePayment"
tags: ["InvoicePayment"]
---

# Creates an InvoicePayment

`POST /InvoicePayment`

## Request

- Base URL: `https://yourorgsite.com/api`
- URL: `https://yourorgsite.com/api/InvoicePayment`
- Auth: OAuth 2
  - Implicit: `https://yourorgsite.com`

Creates an instance of InvoicePayment

## Request body

- InvoicePaymentData
  - `$type` 'Asi.Soa.Commerce.DataContracts.InvoicePaymentData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.InvoicePaymentData, Asi.Contracts"
  - `InvoiceId` string
  - `InvoiceKey` string
  - `InvoiceNumber` string
  - `Payment` RemittanceData
    - `$type` 'Asi.Services.DataVault.Contracts.RemittanceData, Asi.Contracts', required: The DataType must be "Asi.Services.DataVault.Contracts.RemittanceData, Asi.Contracts"
    - `Amount` RemittanceAmountData
      - `$type` 'Asi.Services.DataVault.Contracts.RemittanceAmountData, Asi.Contracts', required: The DataType must be "Asi.Services.DataVault.Contracts.RemittanceAmountData, Asi.Contracts"
      - `Amount` object
      - `Currency` CurrencyData
        - `$type` 'Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"
        - `CurrencyCode` string
        - `DecimalPositions` integer
      - `IsAmountDefined` boolean
    - `ContactId` string
    - `GatewayAccountKey` string
    - `Id` string
    - `Intent` object
    - `InternalRecurringInstructionId` string
    - `InvoiceNumber` integer
    - `IsMoto` boolean
    - `Nickname` string
    - `PaymentMethod` PaymentTokenData
      - `$type` 'Asi.Services.DataVault.Contracts.PaymentTokenData, Asi.Contracts', required: The DataType must be "Asi.Services.DataVault.Contracts.PaymentTokenData, Asi.Contracts"
      - `CustomerId` string
      - `Description` string
      - `IsReadOnly` boolean
      - `Metadata` object
      - `OriginalPaymentToken` string
      - `PaymentTokenExpirationDate` string, date-time
    - `ProcessOn` string, date-time
    - `ReplacementPaymentToken` PaymentTokenData
      - `$type` 'Asi.Services.DataVault.Contracts.PaymentTokenData, Asi.Contracts', required: The DataType must be "Asi.Services.DataVault.Contracts.PaymentTokenData, Asi.Contracts"
      - `CustomerId` string
      - `Description` string
      - `IsReadOnly` boolean
      - `Metadata` object
      - `OriginalPaymentToken` string
      - `PaymentTokenExpirationDate` string, date-time
    - `Status` RemittanceStatusData
      - `$type` 'Asi.Services.DataVault.Contracts.RemittanceStatusData, Asi.Contracts', required: The DataType must be "Asi.Services.DataVault.Contracts.RemittanceStatusData, Asi.Contracts"
      - `AuthorizationCode` string
      - `GatewayTransactionIdentifier` string
      - `Msg` string
      - `StatusCode` 'AwaitingProcessing' | 'InProcess' | 'Completed' | 'Failed' | 'Approved' | 'AwaitingReconciliation' | 'NeedsReview'
    - `StatusUpdatedOn` string, date-time
    - `ThreeDS` ThreeDSPayloadData
      - `$type` 'DataVault.Contracts.ThreeDSPayloadData, Asi.Contracts', required: The DataType must be "DataVault.Contracts.ThreeDSPayloadData, Asi.Contracts"
      - `CAVV` string
      - `DSTransactionId` string
      - `ECIFlag` string
      - `Enrolled` string
      - `IsMerchantInitiated` boolean
      - `IsRecurring` boolean
      - `PAResStatus` string
      - `SignatureVerification` string
      - `ThreeDSVersion` string
      - `XID` string
    - `TransactionDate` string, date-time

## Response `200`

The request was successful.

## Other responses

- `201`: The resource was successfully created.
- `202`: The resource was asynchronously created.

---

[API](https://skmtc.dev/imis/apis/payments.md) - [All operations](https://skmtc.dev/imis/apis/payments/llms.txt) - [OpenAPI document](https://skmtc.dev/imis/apis/payments/revisions/e0669f9d110b?raw)