# Import a payment

Import a payment against an invoice with a custom reference.

Endpoint: POST /payments:import
Version: 1.0.0
Security: Biller Access Token (Production), Biller Access Token (Staging)

## Request fields (application/json):

  - `invoiceId` (string, required)
    ID of the invoice to apply payment to
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `amount` (number, required)
    Payment amount
    Example: 100.5

  - `reference` (string, required)
    Unique payment reference identifier for tracking
    Example: "REF-20250104"

## Response 200 fields (application/json):

  - `payments` (array)
    The list of payments created as a result of the import

  - `payments.id` (string, required)
    The internal id of the payment

  - `payments.paymentRequestId` (string, required)
    The ID of the payment request

  - `payments.creationTime` (string, required)
    The date when the payment was initiated

  - `payments.lastUpdatedTime` (string)
    The last time when the payment was updated

  - `payments.amount` (number, required)
    The paid amount

  - `payments.status` (string, required)
    Statuses for payments. 
Possible values (non-exclusive): PENDING, SUBMITTED, SENT, SUCCESS, CANCELLED, FAILED, SETTLED

  - `payments.paymentMethod` (string, required)
    Payment method types. 
Possible values (non-exclusive): BANK_PAYMENT, CARD, APPLE_PAY, GOOGLE_PAY, DIRECT_DEBIT, IMPORTED, MANUAL_BANK_TRANSFER, BANK_TRANSFER, AMEX

  - `payments.channelPaymentId` (string, required)
    Unique identifier for the payment in the payment provider's system

  - `payments.channelPaymentUrl` (string)
    The URL generated by the payment provider to perform the payment

  - `payments.channelReferenceId` (string)
    The remittance reference ID for bank payments

  - `payments.externalData` (array)
    References about this payment from external platforms Adfin integrates with

  - `payments.externalData.connectorType` (string)
    The connector type. 
Possible values (non-exclusive): XERO, QUICKBOOKS, BRIDGE, STRIPE, PLATFORM

  - `payments.externalData.id` (string)
    ID of the payment in the external platform

  - `payments.metadata` (object)


## Response 400 fields

## Response 401 fields

## Response 422 fields

## Response 500 fields