Skip to main content
PATCH
Update payment

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

payment_id
string<uuid>
required

Body

application/json

Update Payment Request Schema

payment_parts
PaymentPart · object[] | null

Payment Parts

Response

Successful Response

Payment Response Schema

id
string<uuid>
required

Payment Id

amount
string
required
amount_refunded
string
required
currency_code
string
required
status
enum<string> | null
required

Payment Status

Available options:
in_progress,
requires_action,
pending_charge,
authorized,
created,
success,
voided,
failed,
canceled,
refunded,
partially_refunded,
other
customer_id
string<uuid> | null
customer_name
string | null
customer_email
string | null
customer_external_id
string | null
connector_id
string<uuid> | null
connector_name
string | null
organisation_id
string<uuid> | null
external_id
string | null
payment_method
enum<string> | null
Available options:
card,
cash,
check,
charge_back,
bank_transfer,
direct_debit,
amazon_payments,
paypal_express_checkout,
upi,
netbanking_emandates,
other,
credits,
ach_credit_transfer
payment_method_details
Payment Method Details · object | null
type
enum<string> | null
Available options:
payment,
refund,
payment_reversal,
authorization,
tax_withheld
parent_id
string<uuid> | null
invoices
InvoiceAmounts · object[] | null
timestamp
string<date-time> | null
transactions
TransactionResponseSchema · object[] | null
error_text
string | null

Error Message

created_at
string | null

created_at

receipt_number
string | null

receipt_number

balance_transactions
Balance Transactions · object | null

balance_transactions