GET v1/Payments/{id}

Get a Payment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Payment
NameDescriptionTypeAdditional information
Id

The unique Cin7 payment Id.

integer

None.

CreatedDate

Created Date UTC: yyyy-MM-dd HH:mm:ss

date

None.

ModifiedDate

Modified Date UTC: yyyy-MM-dd HH:mm:ss

date

None.

PaymentDate

Payment Date UTC: yyyy-MM-dd HH:mm:ss

date

None.

Amount

Payment Amount

decimal number

None.

Method

Payment Method

string

None.

IsAuthorized

Transaction Authorized

boolean

None.

TransactionRef

Transaction reference e.g. payment gateway transaction Id or ref

string

Max length: 50

Comments

Comments

string

Max length: 250

OrderId

The unique Cin7 sales order or purchase order Id.

integer

None.

OrderRef

A unique sales order or purchase order reference. (Readonly)

string

Max length: 30

PaymentImportedRef

Payment imported ref

string

None.

BatchReference

Batch Reference (Readonly)

string

None.

ReconcileDate

Reconcile date

date

None.

BranchId

Branch Id.

integer

None.

OrderType

Order Type.

OrderType

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "createdDate": "2020-10-19T02:20:46.5939481Z",
  "modifiedDate": null,
  "paymentDate": "2020-10-19T02:20:46.5939481Z",
  "amount": 196.1,
  "method": "Credit Card",
  "isAuthorized": true,
  "transactionRef": "PAYMENT-GATEWAY-REF",
  "comments": "Comment...",
  "orderId": 128,
  "orderRef": "SALE4-28",
  "paymentImportedRef": "INTEGRATION-REF",
  "batchReference": null,
  "reconcileDate": "2020-10-20T15:20:46.5939481+13:00",
  "branchId": 0,
  "orderType": "Undefined"
}