ADadfin
Payments

Import a payment

Changed on

Import a payment against a payment request with a custom reference. The payment request must be a standalone payment request or a payment request with a one-to-one invoice association.

post/payments:import

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/payments:import
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.staging.adfin.com/api/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: https://api.adfin.com/api/oauth2/token

Request body

paymentRequestIdstring uuid required

ID of the payment request to apply the payment to. The payment request must be a standalone payment request or a payment request with a one-to-one invoice association.

amountnumber required

Payment amount

referencestring required

Unique payment reference identifier for tracking. A reference can be used once per payment request. It can be used again after that payment is cancelled.

Example request

{
  "paymentRequestId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 100.5,
  "reference": "REF-20250104"
}

Response

Payment successfully imported.

Changes

  • 4836f9e75a6cRevision changes
    • info

      the endpoint scheme security Biller Access Token (Production) was added to the API

    • info

      the endpoint scheme security Biller Access Token (Staging) was added to the API

  • cbec1c02c8cfRevision changes
    • breaking

      the request property's minLength was increased from 0 to 1