Add Payment to an Invoice

post

https://api-test.qualpay.com/platform/invoice/{invoice_id}/payments

Adds a payment to a SAVED or OUTSTANDING invoice.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoice_id

int64

required

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

Body Params

Invoice Payment

amt_paid

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.

date_payment

string

required

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

description

string

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

transaction_id

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.

type

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

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Request Validation Failed

500Internal Error