Payments record the flow of money in and out of a claim, representing money spent or money received. They can optionally link to a beneficiary object, which contains payment details of the beneficiary bank account.

Payments must belong to a claim and can't exist outside of a claim.

The `Payment` Object

Attribute	Data Type	Description
id	Integer	The unique ID for the payment given by Claimable.
description	String	A free text description of the purpose of this payment.
net_amount	Integer	The net amount in cents, before tax/VAT.
vat	Integer	The amount of tax/VAT in cents.
amount	Integer	The gross/final amount (after tax/VAT) in cents.
payment_date	Date	The date the payment was made.
payment_method	String	Describes the method in which payment is disbursed.
payment_type	String	Describes the type of payment category as it relates to the parent claim.
reference	String	Read Only A unique reference auto-generated by the Claimable API.
beneficiary	Object	A `Beneficiary` object.
created_at	Timestamp	Read Only The date/time the payment was created.

Example Payment Object

{
  "created_at": "2020-12-07T13:26:24.637Z",
  "description": "Payout to claimant",
  "payment_method": "bank_transfer",
  "payment_date": "2020-12-16",
  "payment_type": "cash_settlement",
  "net_amount": 10000,
  "vat": 2000,
  "amount": 12000,
  "beneficiary": {
    "id": 1111,
    "type": "contact",
    "account_number": "102103",
    "bank_name": "HSBC",
    "account_holder_name": "David Mentmore",
    "iban": "GB26MIDL40051512345674",
    "sort_code": "400515",
    "swift_bic": "HBUKGB4BXXX",
    "name": "David Mentmore"
  }
}

The `Beneficiary` Object

Attribute	Data Type	Description
id	Integer	The unique ID for the beneficiary given by Claimable.
type	String	One of: `contact` or `company` Payment beneficiaries can be either `contact` or `company`.
account_number	String	Read Only The account number of the beneficiary bank account.
bank_name	String	Read Only The name of the bank holding the beneficiary bank account.
account_holder_name	String	Read Only The bank account holder's name of the beneficiary bank account.
iban	String	Read Only The IBAN number of the beneficiary bank account.
sort_code	String	Read Only The sort code (UK/Ireland) of the beneficiary bank account.
swift_bic	String	Read Only The SWIFT/BIC of the beneficiary bank account.
name	String	Read Only The name of the beneficiary.

Example Beneficiary Object

{
  "id": 1111,
  "type": "contact",
  "account_number": "102103",
  "bank_name": "HSBC",
  "account_holder_name": "David Mentmore",
  "iban": "GB26MIDL40051512345674",
  "sort_code": "400515",
  "swift_bic": "HBUKGB4BXXX",
  "name": "David Mentmore"
}

The Payment Object

The Beneficiary Object

The `Payment` Object

The `Beneficiary` Object