Payments

Create payment

Changed on

Use when recording a payment against an invoice (e.g. after receiving funds via a gateway or manual entry).

post/payments

Request

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

Request body

amountstring required
cancel_urlstring
currencystring required
destination_idstring required
destination_type'INVOICE' | 'CUSTOMER' required
idempotency_keystring
metadataTypesMetadata
payment_gateway'stripe' | 'razorpay' | 'nomod' | 'moyasar' | 'paddle' | 'whop' | 'chargebee'
payment_method_idstring
payment_method_type'CARD' | 'ACH' | 'OFFLINE' | 'CREDITS' | 'PAYMENT_LINK' | 'UPI' required
process_paymentboolean
save_card_and_make_defaultboolean
success_urlstring

Response

Created 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