ReferencePayments

Update Shipping Courier

This endpoint updates an order with shipping courier information. The Afterpay team may utilise this information when providing support. **Connection Timeouts** | Timeout | Time (Seconds) | |---------|----------------| | Open | 10 | | Read | 20 |

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Path parameters

orderIdstringRequired
The unique Afterpay Order ID to update.

Headers

User-AgentstringRequired
AcceptenumOptional
Allowed values:

Request

shippedAtstringOptionalformat: "date-time"
The date and time when the order was shipped, in ISO 8601 format.
namestringOptional<=128 characters
The name of the courier.
trackingstringOptional<=128 characters
The tracking number provided by the courier.
priorityenumOptional
The shipping priority.
Allowed values:

Response

Returns a Payment object in response.
idstring or null
The unique, permanent, Afterpay generated Order ID.
tokenstring or null
The token obtained from the checkout call
statusenum or null
represents the status of the order
Allowed values:
createdstring or null
The UTC timestamp of when the payment was completed.
originalAmountobject or null
Total amount charged to the customer for the order.
openToCaptureAmountobject or null
Remaining amount that can be captured. Will always be zero for Immediate Payment Flow orders.
paymentStateenum or null
is the current state for capturing payments
merchantReferencestring or null

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

refundslist of objects or null

An array of refunds. Note: in response to a Capture Full Payment call, this array will always be empty, since refunds cannot occur until payment is captured.

orderDetailsobject or null
The details of the order bound to the payment.
eventslist of objects or null
One or more payment events that have occurred against the order.
agreementslist of objects or null

List of billing agreements created if any (field omitted if empty)

Errors