APappdirect
PurchaseOrder

List all purchase order payments

Changed on

List all purchase order payments

get/billing/v1/orders/{orderId}/payments

Request

Path parameters

orderIdnumber required

The specific order id for which information is requested

Query parameters

countstring

Number of results to fetch. Used for paging.

fromDatenumber

Filter by the start date of the invoice

method'ADP_INVOICE' | 'ARIBAPAY' | 'BT_BILL' | 'CLICKANDBUY' | 'CLOUDFOUNDRY' | 'CREDIT_CARD' | 'CUMULA_BILL' | 'DTAG' | 'EXTERNAL_INVOICE' | 'KREDITKARTE' | 'LASTSCHRIFT_MRNEXNET' | 'MANO_TEO_BILL' | 'MANUAL' | 'MARKETPLACE_CREDITS' | 'NETS_ARVATO_INVOICE' | 'NEXTEL' | 'PAYPAL' | 'ROGERS_CC_DTMF' | 'ROGERS_CC_POS' | 'SNAP' | 'TBILL' | 'THISTLE' | 'TOICLEARING'

Filter by method of the payment

result'FAILED' | 'GATEWAY_NOT_AVAILABLE' | 'MANUAL' | 'SUCCESSFUL'

Filter by results of the payment

sortField'AMOUNT' | 'DATE' | 'PAYMENT_ID'

The filed to be used for sorting com.appdirect.backend.api.billing.types.OrderSortWS.

sortOrder'ASC' | 'DESC'

Sort order org.springframework.data.domain.Sort.Direction.

startstring

First result index. Used for paging.

toDatenumber

Filter by the end date of the invoice

Response

OK

amountnumber nullable

Payment amount.

currency'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN'

Supported currencies for the system

datenumber nullable

Payment date.

idnumber nullable

Payment number.

method'CREDIT_CARD' | 'PAYPAL' | 'MANUAL' | 'EXTERNAL_INVOICE' | 'MARKETPLACE_CREDITS'

The supported payment methods

result'SUCCESSFUL' | 'FAILED' | 'GATEWAY_NOT_AVAILABLE' | 'MANUAL'
transactionIdstring nullable

Transaction ID.

Example response

[
  {
    "amount": 12345,
    "company": {
      "href": "...",
      "id": "..."
    },
    "currency": "INR",
    "date": 12345,
    "gatewayResponse": {
      "avs": true,
      "code": "...",
      "cvv": true,
      "message": "..."
    },
    "id": 12345,
    "links": [
      {
        "href": "...",
        "rel": "..."
      },
      {
        "href": "...",
        "rel": "..."
      }
    ],
    "method": "PAYPAL",
    "result": "GATEWAY_NOT_AVAILABLE",
    "transactionId": "...",
    "user": {
      "href": "...",
      "id": "..."
    }
  }
]

Changes