API Reference

Create payment

post
https://api.wafeq.com/v1/payments/

Endpoint for creating a new payment.

Body Params

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

double
required

The total amount of the payment including fees. Must be greater than zero.

bill_payments
array of objects

A list of objects to represent bill payments. Required if paying bills.

bill_payments
string

The unique identifier of the contact associated with this payment.

string | null

The unique identifier of the cost center associated with this payment.

credit_note_payments
array of objects

A list of objects to represent credit note payments. Required if applying credit notes.

credit_note_payments
string
enum
required
  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • ...

Full information for CurrencyEnum

date
required

The date when the payment was made or received.

debit_note_payments
array of objects

A list of objects to represent debit note payments. Required if paying debit notes.

debit_note_payments
string

The unique identifier of the employee associated with this payment. Required for payslip payments.

string
length ≤ 255

External identifier for the payment.

invoice_payments
array of objects

A list of objects to represent invoice payments. Required if paying invoices.

invoice_payments
string
required

The account used for this payment. Must be a valid payment account.

double

The fees paid for this payment. If set, must be greater than zero.

string | null

The account to categorize the payment fees. Required if payment_fees is set.

payslip_payments
array of objects

A list of objects to represent payslip payments. Required if paying payslips.

payslip_payments
string | null

The unique identifier of the project associated with this payment.

string
Headers
string

Client-provided UUID to uniquely identify a request

Response

Updated 10 days ago

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

Updated 10 days ago