Update Shipping Courier

This endpoint updates an order with shipping courier information. The Afterpay team may use this information when providing support.

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read20
put/v2/payments/{orderId}/courier

Request

  • Base URL: https://global-api-sandbox.afterpay.com
  • URL: https://global-api-sandbox.afterpay.com/v2/payments/{orderId}/courier
  • Auth: HTTP basic

Path parameters

orderIdstring required

The unique Afterpay Order ID to update.

Headers

User-Agentstring required
Accept'application/json'

Request body

shippedAtstring date-time
namestring
trackingstring
priority'STANDARD' | 'EXPRESS'

Response

Returns a Payment object in response.

idstring

The unique, permanent, Afterpay generated Order ID.

tokenstring

The token obtained from the checkout call

status'APPROVED' | 'DECLINED'

represents the status of the order

createdstring

is the UTC timestamp of when the payment was completed.

paymentState'AUTH_APPROVED' | 'AUTH_DECLINED' | 'PARTIALLY_CAPTURED' | 'CAPTURED' | 'CAPTURE_DECLINED' | 'VOIDED'

is the current state for capturing payments

merchantReferencestring

is the merchant's order id/reference that the payment corresponds to.

Changes

No recorded changes to this operation across all 1 revision of this API.