API Reference
Login to SandboxCreate Account

Update an Invoice Payment

put
https://api-test.qualpay.com/platform/invoice//payments/

Updates a payment on a SAVED or OUTSTANDING invoice. You cannot update credit card payments made through the invoice’s 'Pay Now' button.

Note: This operation requires special permissions for vendor account use. Contact Qualpay Support to enable it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

The invoice ID, returned as the invoice_id value in a 'Create an Invoice' response.

int64
required

The unique ID assigned to an invoice payment, returned as the payment_id value in an 'Add Payment to an Invoice' or 'Get Invoice Payments' request.

Body Params

Invoice Payment

double
required

Format: Variable length, up to 10, 2 N
Description: The amount paid. The payment currency should be the same as the invoice currency.

string
required

Format: Variable length, up to 10 AN, in YYYY-MM-DD format
Description: The date the payment was made.

string

Format: Variable length
Description: A short description of the payment.

string

Format: Fixed length, 32 AN
Description: The Payment Gateway ID of the applied card payment. This is found as the pg_id value in the 'Authorize Transaction' response. Applicable only to a CREDIT-type transaction.

string
enum
required

Format: Variable length, up to 16 AN
Description: The mode of payment. Select from the following:

  • CASH - A cash payment.
  • CHECK - A check payment.
  • CREDIT - A credit card payment.
  • OTHER - Another mode of payment.

Allowed:
Responses

Updated 18 days ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago