Payments

Update payment

Changed on

Use when updating payment status or metadata (e.g. after reconciliation or adding a reference).

put/payments/{id}

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/payments/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Payment ID

Request body

error_messagestring
failed_atstring date-time
gateway_payment_idstring
gateway_tracking_idstring

GatewayTrackingID is the pre-payment handle at the gateway — link, hosted page, invoice or order — recorded at checkout creation so the payment can be reconciled.

metadataTypesMetadata
payment_gatewaystring
payment_method_idstring
payment_statusstring
refunded_atstring date-time
succeeded_atstring date-time
voided_atstring date-time

Response

Updated payment

amountstring
created_atstring date-time
created_bystring
currencystring
destination_idstring
destination_type'INVOICE' | 'CUSTOMER'
environment_idstring
error_messagestring
failed_atstring date-time
gateway_metadataTypesMetadata
gateway_payment_idstring
gateway_tracking_idstring
idstring
idempotency_keystring
invoice_numberstring
metadataTypesMetadata
payment_gatewaystring
payment_method_idstring
payment_method_type'CARD' | 'ACH' | 'OFFLINE' | 'CREDITS' | 'PAYMENT_LINK' | 'UPI'
payment_status'INITIATED' | 'PENDING' | 'PROCESSING' | 'SUCCEEDED' | 'OVERPAID' | 'FAILED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'VOIDED'
payment_urlstring
refunded_atstring date-time
save_card_and_make_defaultboolean
succeeded_atstring date-time
tenant_idstring
track_attemptsboolean
updated_atstring date-time
updated_bystring
voided_atstring date-time

Changes