v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB

Payment

Update a server payment

Updates an existing payment with new information.

This endpoint allows you to modify payment details such as billing information, customer details, or other payment metadata after the payment has been created but before it's finalized.

post/api/server/payment/{paymentId}

Path parameters

paymentIdstring required

Example:pay_1234567890abcdef

Unique identifier of the payment to update

Request body

currency'EUR' | 'USD'

Payment currency. Will update the payment currency if provided, otherwise the payment currency will not be updated.

customerEmailstring email required

Customer email address

billingCountrystring required

Billing country code (ISO 3166-1 alpha-2)

postalCodestring

Billing postal code (required for some countries like US)

purchasingAsBusinessboolean

Whether the purchase is for a business

businessNamestring

Business name (required if purchasingAsBusiness is true)

taxIdstring

Business tax ID (required if purchasingAsBusiness is true)

firstNamestring

First name

namestring required

Customer's name. This field accepts EITHER the full name (e.g., 'John Doe') OR just the last name (e.g., 'Doe') if you also provide the firstName field separately. Choose one approach: (1) Use only this 'name' field with the full name, OR (2) Use both 'firstName' and 'name' fields where 'name' contains only the last name.

metadatasobject

Optional metadata (key-value pairs)

autoConfirmboolean

Auto-confirm the payment (default false). When enabled, the payment is processed immediately if no 3DS step is required, or right after a successful 3DS authentication.

force3dsboolean

Force 3DS authentication directly. With card information (on-session) the 3DS is forced even if it is not strictly required.

pricingMode'TAX_EXCLUSIVE' | 'TAX_INCLUSIVE'

Pricing mode for the products. TAX_EXCLUSIVE (default): Product prices are excluding tax (HT), tax is added on top to calculate the final amount. TAX_INCLUSIVE: Product prices include tax (TTC), tax is extracted from the total while keeping the final amount fixed.

threeDsSuccessUrlstring

URL to redirect to after successful 3DS authentication, only required if card information is provided

threeDsFailureUrlstring

URL to redirect to after failed 3DS authentication, only required if card information is provided

statementDescriptorstring

Optional statement descriptor (max 11 characters) shown on the customer's bank statement as 'INFLOWPAY* <descriptor>'. Falls back to the account-level statement descriptor if omitted.

Example request

{
  "card": {
    "number": "4242424242424242",
    "expiration_month": 12,
    "expiration_year": 2025,
    "cvc": "123"
  },
  "products": [
    {
      "name": "Premium Subscription",
      "price": 10000,
      "quantity": 1
    },
    {
      "name": "Setup Fee",
      "price": 5000,
      "quantity": 1
    }
  ],
  "currency": "EUR",
  "customerEmail": "customer@example.com",
  "billingCountry": "FR",
  "postalCode": "75001",
  "businessName": "Acme Corp",
  "taxId": "FR12345678901",
  "firstName": "John",
  "name": "Doe",
  "pricingMode": "TAX_EXCLUSIVE",
  "threeDsSuccessUrl": "https://yourapp.com/payment/success?paymentId=pay_123",
  "threeDsFailureUrl": "https://yourapp.com/payment/failure?paymentId=pay_123",
  "statementDescriptor": "MY BRAND"
}

Response

Update a server payment successful

idstring required

The id of the payment

amountnumber required

The amount of the payment in cents, this has been calculated from the products prices and quantities

customerEmailstring required

The email of the customer

customerIdstring nullable

The id of the customer

currency'EUR' | 'GBP' | 'USD' required

The currency of the payment, this currency will refer to product list prices

metadatasobject

The metadatas of the payment

The status of the payment, exhaustive list of status to come

captureMode'AUTOMATIC' | 'MANUAL' required

AUTOMATIC or MANUAL (authorize now, capture later)

authorizedAtstring date-time nullable

capturedAmountInCentsnumber required

Total amount captured in cents (TTC)

createdAtstring date-time required

The creation date of the payment

updatedAtstring date-time required

The last update date of the payment

subscriptionIdstring nullable

The subscription id if payment is part of a subscription

taxCountrystring nullable

The tax country of the payment

amountTaxesIncludednumber nullable

The total amount including taxes in cents

depositStatusstring nullable

The status from the deposit payment service provider

taxRateInPercentagenumber nullable

The tax rate in percentage applied to the payment

pricingModestring nullable

The pricing mode used for the payment. TAX_EXCLUSIVE (default): Prices are excluding tax (HT), tax is added on top. TAX_INCLUSIVE: Prices include tax (TTC), tax is extracted from total.

expiresAtstring date-time nullable

The expiration date of the payment

invoiceUrlstring nullable

URL to view and download the invoice (available after payment success)

threeDsSessionUrlobject nullable

The URL to redirect to after successful 3DS authentication

Example response

{
  "lastDepositAttempt": {
    "status": "succeeded",
    "amount": 10000,
    "paymentMethod": "CARD",
    "error": "card_declined",
    "attemptedAt": "2025-10-24T14:35:00Z"
  },
  "taxRateInPercentage": 20,
  "pricingMode": "TAX_EXCLUSIVE",
  "lastThreeDsAttempt": {
    "status": "succeeded",
    "cardBrand": "Visa",
    "createdDate": "2025-11-12T21:51:33.530Z"
  },
  "invoiceUrl": "https://api.inflowpay.com/invoice/download?token=abc123xyz",
  "customerPaymentMethod": {
    "id": "cpm_abc123",
    "type": "card",
    "cardBrand": "visa",
    "cardLast4": "4242"
  }
}