Payments
Authorizations
Header parameters
organization-idstringRequired
Organization ID
Body
Responses
200Success
application/json
400
Functional Error
application/json
post
POST /v1/om/payments HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 223
{
"params": {
"orderId": "text",
"type": "receipt",
"custom": true,
"amount": 1,
"methodId": "text",
"customerUid": "text",
"status": "complete",
"sourcePaymentId": "text",
"transactionRef": "text",
"attrs": {},
"invoiceId": "text",
"note": "text"
}
}
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"id": "text"
}
}
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
400
Functional Error
application/json
delete
DELETE /v1/om/payments/{uid} HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"items": [
{
"type": "receipt",
"status": "complete",
"completedAt": "text",
"reversedAt": "text",
"custom": true,
"amount": 1,
"sourcePaymentId": "text",
"transactionRef": "text",
"attrs": {},
"invoiceId": "text",
"note": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text",
"can": [
"confirm"
],
"methodUid": "text"
}
],
"paymentMethods": [
{
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"visible": true,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text"
}
]
}
}
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired
Organization ID
Body
Responses
200Success
application/json
400
Functional Error
application/json
patch
PATCH /v1/om/payments/{uid} HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"params": {
"id": "text",
"orderId": "text",
"amount": 1,
"methodId": "text",
"custom": true,
"correction": true,
"customerUid": "text",
"status": "complete",
"sourcePaymentId": "text",
"transactionRef": "text",
"attrs": {},
"note": "text"
}
}
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"success": true
}
}
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired
Organization ID
Body
Responses
200Success
application/json
400
Functional Error
application/json
patch
PATCH /v1/om/payments/{uid}/confirm HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"params": {
"id": "text",
"orderId": "text",
"customerUid": "text",
"transactionRef": "text",
"attrs": {}
}
}
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"items": [
{
"type": "receipt",
"status": "complete",
"completedAt": "text",
"reversedAt": "text",
"custom": true,
"amount": 1,
"sourcePaymentId": "text",
"transactionRef": "text",
"attrs": {},
"invoiceId": "text",
"note": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text",
"can": [
"confirm"
],
"methodUid": "text"
}
],
"paymentMethods": [
{
"locales": {
"ar": {
"name": "text",
"description": "text"
},
"en": {
"name": "text",
"description": "text"
}
},
"visible": true,
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text"
}
]
}
}
Was this helpful?