Commerce APIs
PATCH Payment
- Documentation
- Introduction
- Overview
- Quickstart
- Errors
- Pagination
Wallet Creation APIs
Wallet Experience APIs
NFT APIs
Web3 APIs
SDK
Overview
Wallet as a Service (WaaS)
Commerce APIs
PATCH Payment
Update payment method for an order.
PATCH
/
v1
/
orders
/
{orderId}
/
payments
/
{paymentId}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
curl -X 'PATCH' \
'https://api.bitski.com/v1/orders/3fa85f64-5717-4562-b3fc-2c963f66afa6/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-d '{
"payment": {
"paymentMethodId": "pm_1Mz4es2eZvKYlo2CSnrUx5Z6",
"status": "completed"
}
}'
{
"order": {
"createdAt": "2023-04-20T21:05:20.976Z",
"currency": "USD",
"fees": "1.00",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"items": [
{
"amount": "10.00",
"fees": "1.00",
"productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"taxes": "1.00"
}
],
"status": "DRAFT",
"subtotal": "10.00",
"taxes": "1.00",
"total": "12.00"
},
"payment": {
"createdAt": "2023-04-20T21:05:20.976Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"nextAction": null,
"paymentMethodDescription": "Visa 4111",
"paymentMethodId": "pm_1Mz4es2eZvKYlo2CSnrUx5Z6"
}
}
Access to this API is available upon request to sales@bitski.com.
Examples
Response
order
Order object
requiredid
string
requiredcreatedAt
string
requiredcurrency
string
requireditems
array
requiredstatus
string
requiredsubtotal
string
requiredfees
string
requiredtaxes
string
requiredtotal
string
requiredpayment
Payment object
requiredid
string
requiredcreatedAt
string
requirednextAction
object
paymentMethodDescription
object
requiredpaymentMethodId
string
requiredcurl -X 'PATCH' \
'https://api.bitski.com/v1/orders/3fa85f64-5717-4562-b3fc-2c963f66afa6/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-d '{
"payment": {
"paymentMethodId": "pm_1Mz4es2eZvKYlo2CSnrUx5Z6",
"status": "completed"
}
}'
{
"order": {
"createdAt": "2023-04-20T21:05:20.976Z",
"currency": "USD",
"fees": "1.00",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"items": [
{
"amount": "10.00",
"fees": "1.00",
"productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"taxes": "1.00"
}
],
"status": "DRAFT",
"subtotal": "10.00",
"taxes": "1.00",
"total": "12.00"
},
"payment": {
"createdAt": "2023-04-20T21:05:20.976Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"nextAction": null,
"paymentMethodDescription": "Visa 4111",
"paymentMethodId": "pm_1Mz4es2eZvKYlo2CSnrUx5Z6"
}
}