Get Paid Transactions By Order Number

get https://restpilot.paylink.sa/api/getOrder/{orderNumber}

Allows developers to retrieve details about a specific order in an e-commerce platform, with the Order Number as the input parameter. This endpoint can be integrated into an invoicing system to allow merchants to view detailed information about an individual order, such as customer details, payment status, and order total. The response from this endpoint will contain a JSON object that includes all the relevant order information.

Responses

Response body

object

clientMobile

string

The phone number of the client who placed the order

clientName

string

The name of the client who placed the order.

isReconciled

boolean

Indicates whether the order has been reconciled.

note

string

A note associated with the order.

orderAmount

double

Refers to the total amount charged for an order.

orderDate

date-time

Refers to the date a customer placed an order in an e-commerce platform.

orderId

int64

The unique identifier of the order.

orderNumber

string

Refers to a unique identifier assigned to an order in a merchant e-commerce platform.

orderStatus

string

Refers to the payment status for an order

paylinkFees

double

The fees charged by Paylink, if applicable.

paylinkVat

double

The VAT charged by Paylink, if applicable

settlementAmount

double

The amount settled, if applicable.

settlementBank

string

The bank account number for the settlement, if applicable.

settlementIban

string

The IBAN for the settlement, if applicable.

settlementNumber

string

The settlement number, if applicable.

transactionNo

string

Refers to a unique identifier assigned to an order in Paylink system.

401

You are not authorized to view the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

200Successfully get the invoice