Paystar API (1.0.0)

Download OpenAPI specification:Download

Get payment session details by client provided reference

Authorizations:

ApiKeyAuth

query Parameters

clientReference

required

string

Client provided reference for the payment session

Responses

Response samples

200

Content type

application/json

{"data": {"paymentSession": {"identifier": "14d3030c-3b61-4070-b902-342f80e99364",
"createdDateUtc": "2019-08-24T14:15:22Z",
"businessUnitSlug": "string",
"channel": "string",
"status": "string",
"subtotal": 0,
"serviceFeeCalculation": {"tier": {"paymentChannel": "string",
"paymentSourceType": "string",
"startRange": 0,
"endRange": 0,
"flatFee": 0,
"percentageFee": 0,
"id": 0
},
"amount": 0
}
},
"paymentFields": {"property1": "string",
"property2": "string"
},
"payment": {"status": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"amountMinor": 0,
"serviceFeeAmountMinor": 0,
"paymentDescriptor": "string",
"referenceNumber": "string",
"authCode": "string",
"gatewayResponseDescription": "string"
},
"paymentSource": {"paymentSourceType": "string",
"accountHolderName": "string",
"accountType": "string",
"accountNumberLast4": "string"
},
"lineItems": [{"lineItemType": "string",
"description": "string",
"priceMinor": 0,
"accountNumber": "string",
"subAccountNumber": "string",
"productSku": "string",
"productName": "string"
}
],
"canProcessSession": true
},
"hasErrors": true,
"errors": [{ }
]
}

Get payment session identifier

Authorizations:

ApiKeyAuth

path Parameters

sessionIdentifier

required

string

Unique session identifier

Responses

Response samples

200

Content type

application/json

{"data": {"paymentSession": {"identifier": "14d3030c-3b61-4070-b902-342f80e99364",
"createdDateUtc": "2019-08-24T14:15:22Z",
"businessUnitSlug": "string",
"channel": "string",
"status": "string",
"subtotal": 0,
"serviceFeeCalculation": {"tier": {"paymentChannel": "string",
"paymentSourceType": "string",
"startRange": 0,
"endRange": 0,
"flatFee": 0,
"percentageFee": 0,
"id": 0
},
"amount": 0
}
},
"paymentFields": {"property1": "string",
"property2": "string"
},
"payment": {"status": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"amountMinor": 0,
"serviceFeeAmountMinor": 0,
"paymentDescriptor": "string",
"referenceNumber": "string",
"authCode": "string",
"gatewayResponseDescription": "string"
},
"paymentSource": {"paymentSourceType": "string",
"accountHolderName": "string",
"accountType": "string",
"accountNumberLast4": "string"
},
"lineItems": [{"lineItemType": "string",
"description": "string",
"priceMinor": 0,
"accountNumber": "string",
"subAccountNumber": "string",
"productSku": "string",
"productName": "string"
}
],
"canProcessSession": true
},
"hasErrors": true,
"errors": [{ }
]
}

Query Payments

Authorizations:

ApiKeyAuth

query Parameters

StartDate	string
EndDate	string
ReferenceNumber	string
Page	integer

Responses

Response samples

200

Content type

application/json

{"data": {"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalItemCount": 0,
"items": [{"slug": "string",
"paymentReferenceNumber": "string",
"sessionIdentifier": "string",
"lineItemType": "string",
"description": "string",
"priceMinor": 0,
"accountNumber": "string",
"subAccountNumber": "string",
"productSku": "string",
"productName": "string",
"amountMinor": 0,
"serviceFeeAmountMinor": 0,
"status": "string",
"paymentDate": "2019-08-24T14:15:22Z"
}
]
},
"hasErrors": true,
"errors": [{ }
]
}

Query Line Items

Authorizations:

ApiKeyAuth

query Parameters

StartDate	string
EndDate	string
ReferenceNumber	string
Page	integer

Responses

Response samples

200

Content type

application/json

{"data": {"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalItemCount": 0,
"items": [{"slug": "string",
"paymentReferenceNumber": "string",
"sessionIdentifier": "string",
"lineItemType": "string",
"description": "string",
"priceMinor": 0,
"accountNumber": "string",
"subAccountNumber": "string",
"productSku": "string",
"productName": "string"
}
]
},
"hasErrors": true,
"errors": [{ }
]
}