REST Auth API: PaymentReferences

PaymentReference resources encapsulate the details of a payment transaction associated with an Order or CreditNote.

PaymentReferences may refer to credit card payment (or refund) transactions made through a payment gateway, or may refer to Voucher-based payments allocated against an order.

NOTE: Payments made through processes outside of Arlo (such as bank transfer payments) are not included in this resource. For example, an order can be manually marked as paid by an administrator through processes outside of Arlo without generating a PaymentReference record.

PaymentReference instance resource

Resource URI

Instances can be accessed as children of a related Order or CreditNote.

/api/2012-02-01/auth/resources/orders/{OrderID}/paymentreferences/

General structure

<PaymentReference>
  <UniqueIdentifier>22b3fab4-ef56-4d70-9ce0-a7cc3c1a26cd</UniqueIdentifier>
  <PaymentMode>Vendor</PaymentMode>
  <VendorID>PaymentExpress</VendorID>
  <VendorTransactionReference>0000000602d1c2cf</VendorTransactionReference>
  <Amount>100.00</Amount>
  <Description>Visa 41111.........11 JOHN DOE 1020</Description>
  <Reference>ORD-9182-1</Reference>
  <CreatedDateTime>2011-09-30T14:55:31.497Z</CreatedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/orders/302/paymentreferences/22b3fab4-ef56-4d70-9ce0-a7cc3c1a26cd/"/>
</PaymentReference>

Resource properties

Property	Description
UniqueIdentifier	A GUID value that uniquely identifies this resource across any platform.
PaymentMode	A string describing the mode of the payment, such as `Vendor` or `Voucher`.
VendorID	A string with the identifier of the vendor for the payment. Included only if the `PaymentMode` is `Vendor`.
VendorTransactionReference	A string with the transaction reference/code returned by the vendor for the payment. Included only if the `PaymentMode` is `Vendor`.
VoucherCode	A string with the voucher reference/code used for the payment. Included only if the `PaymentMode` is `Voucher`.
Amount	A decimal value for the amount of the payment.
Description	A string describing the payment transaction, up to 128 characters.
Reference	A string with a unique reference for the transaction, usually prefixed with the code of the order to easily identify which order the payment is associated with.

HTTP GET

Returns a representation of a PaymentReference, including the properties and links above.

Optional parameters

Parameter	Description
expand	Expression referencing Link elements to expand when generating the response. See link expansion.

Example

GET /api/2012-02-01/auth/resources/orders/11079/paymentreferences/22b3fab4-ef56-4d70-9ce0-a7cc3c1a26cd/

<PaymentReference>
  <UniqueIdentifier>22b3fab4-ef56-4d70-9ce0-a7cc3c1a26cd</UniqueIdentifier>
  <PaymentMode>Vendor</PaymentMode>
  <VendorID>PaymentExpress</VendorID>
  <VendorTransactionReference>0000000602d1c2cf</VendorTransactionReference>
  <Amount>100.00</Amount>
  <Description>Visa 41111.........11 JOHN DOE 1020</Description>
  <Reference>ORD-9182-1</Reference>
  <CreatedDateTime>2011-09-30T14:55:31.497Z</CreatedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/orders/302/paymentreferences/22b3fab4-ef56-4d70-9ce0-a7cc3c1a26cd/"/>
</PaymentReference>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

PaymentReference collection resource

The PaymentReference collection resource represents the set of PaymentReference resources on an Order.

Resource URI

/api/2012-02-01/auth/resources/orders/11079/paymentreferences/

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual PaymentResources resources, or link expansion can be used via the expand query parameter to inline the entities with the HTTP GET response. See querying collections for general information on handling resource collections.

Optional parameters

Parameter	Description
expand	Expression referencing Link elements to expand when generating the response. See link expansion.
skip	Returns a subset of records from the collection, starting at index N+1 specified by this parameter. The `skip` and `top` parameters are generally used for collection paging.
top	Returns a subset of records from the collection, starting at index 0 or index `skip`, and returns the first N records. The `skip` and `top` parameters are generally used for collection paging.

Example 1

Retrieve a collection of PaymentReference links with the default parameters from an Order, and no link expansion.

GET /api/2012-02-01/auth/resources/orders/11079/paymentreferences/

<PaymentReferences>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/PaymentReference" type="application/xml" title="PaymentReference" href="https://demo.arlo.co/api/2012-02-01/auth/resources/orders/11079/paymentreferences/22b3fab4-ef56-4d70-9ce0-a7cc3c1a26cd/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/PaymentReference" type="application/xml" title="PaymentReference" href="https://demo.arlo.co/api/2012-02-01/auth/resources/orders/11079/paymentreferences/872675f7-bd78-494e-b9b7-1f441a1e79d5/"/>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/orders/11079/paymentreferences/?skip=2"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/orders/11079/paymentreferences/"/>
</PaymentReferences>