Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Account

List all payment requests

Returns a list of your payment requests. If there are unsettled payment requests, they can block you from using the API.

Unsettled payment requests must settled through the Shipmondo app, unless the account is set to automatic settlement.

get/account/payment_requests

Query parameters

created_at_minstring date-time

"From" timestamp for the payment requests to be included in the filter. Examples:

  • 2017-06-19T11:00:03.305+02:00
  • 2017-06-19 will be transformed into 2017-06-19T00:00:00.000+02:00
created_at_maxstring date-time

"To" timestamp for the payment requests to be included in the filter. Examples:

  • 2017-06-29T11:00:03.305+02:00
  • 2017-06-29 will be transformed into 2017-06-29T00:00:00.000+02:00
per_pageinteger

For pagination. Defines how many entries are returned per page.

pageinteger

For pagination. Defines which page the results are fetched from.

Response

Successful.

idinteger

ID of the payment request.

shipment_idinteger

ID of the shipment that the payment request is related to.

referencestring

Information about the nature of the payment request.

line_type'shipment' | 'pickup' | 'fuel' | 'sulphur' | 'road_toll' | 'non_compliant' | 'oversize' | 'island_fee' | 'hanging_garment' | 'alternative_delivery' | 're_addressing' | 'unfit_for_parcel_shop' | 're_delivery' | 'return_freight' | 'overweight' | 'hazardous_goods_service' | 'customs_clearance' | 'remote_area' | 'not_stackable_pallet' | 'time_definite' | 'address_correction' | 'cargo_gods_fee' | 'no_reply' | 'missing_edi_data' | 'oversize_fifty' | 'oversize_60' | 'oversize_115' | 'environmental' | 'security' | 'currency_conversion' | 'drop_off_fee' | 'bag_on_door' | 'barcode_unreadable' | 'barcode_misplaced' | 'shipment_information_correction' | 'seasonal_fee' | 'delivery_obstacles' | 'conversion_fee' | 'non_collected_shipment' | 'evening_delivery' | 'missing_mandatory_notification' | 'gotland_fee' | 'colli_fee' | 'notification' | 'warehouse_rent' | 'parcel_information_correction' | 'outside_product_specification' | 'signature_assurance' | 'brexit' | 'pickup_private' | 'freight_adjustment' | 'customs_entry_prep' | 'customs_document_mailing' | 'customs_ddp' | 'customs_disbursement_fee' | 'customs_import_vat' | 'customs_import_duties' | 'international_process_fee' | 'discount' | 'use_of_refunded_shipment' | 'business_to_private' | 'label_reuse' | 'excess_weight' | 'others' | 'unknown'

Type related to the nature of the payment request.

amountnumber

Amount to be paid.

currency_codestring

Currency code of the amount.

created_atstring date-time

Date and time the payment request was created.

updated_atstring date-time

Date and time the payment request was last updated.

Example response

[
  {
    "id": 11460,
    "shipment_id": 18651353,
    "reference": "Non-compliant",
    "line_type": "non_compliant",
    "amount": 22.5,
    "currency_code": "DKK",
    "created_at": "2017-06-16T06:25:44.557Z",
    "updated_at": "2017-06-16T06:25:44.557Z"
  }
]