PaymentOrchestration

/api/PaymentOrchestration/UpdatePaymentResponse/{companyUId}

SecurityX-API-Key
Request
path Parameters
companyUId
required
string <uuid>
Request Body schema:
string
Responses
200

Success

post/api/PaymentOrchestration/UpdatePaymentResponse/{companyUId}
Request samples
"string"

/api/PaymentOrchestration/UpdateDrayUnitOrchestrationDetails

SecurityX-API-Key
Request
Request Body schema:
serviceOrderUid
string <uuid>
processStartDtTm
string or null <date-time>
processEndDtTm
string or null <date-time>
isManuallyStopped
boolean
hasGatedOut
boolean
companyUid
string <uuid>
tradeTypeCd
string or null
containerNbr
string or null
Responses
200

Success

post/api/PaymentOrchestration/UpdateDrayUnitOrchestrationDetails
Request samples
{
  • "serviceOrderUid": "4018c3db-bc35-4e75-a99d-5fb5777cb2f8",
  • "processStartDtTm": "2019-08-24T14:15:22Z",
  • "processEndDtTm": "2019-08-24T14:15:22Z",
  • "isManuallyStopped": true,
  • "hasGatedOut": true,
  • "companyUid": "34b2f4dd-dd40-41ff-9e00-753013ed267a",
  • "tradeTypeCd": "string",
  • "containerNbr": "string"
}

/api/PaymentOrchestration/AddEnvioOrchestrationFee

SecurityX-API-Key
Request
Request Body schema:
companyUId
string <uuid>
companyName
string or null
containerNumber
string or null
rateName
string or null
serviceOrderUId
string <uuid>
guaranteeThroughDate
string <date-time>
transactionId
string <uuid>
rateNames
Array of strings or null
feeAmount
number <double>
chargeId
string <uuid>
actionCode
string or null
chargeReference
integer <int32>
isDualMove
boolean
Responses
200

Success

post/api/PaymentOrchestration/AddEnvioOrchestrationFee
Request samples
{
  • "companyUId": "9b983c4f-7ae4-4765-8ec3-56a3d3042058",
  • "companyName": "string",
  • "containerNumber": "string",
  • "rateName": "string",
  • "serviceOrderUId": "4009d928-0f41-4b85-b577-2f40ea9fafaf",
  • "guaranteeThroughDate": "2019-08-24T14:15:22Z",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "rateNames": [
    ],
  • "feeAmount": 0,
  • "chargeId": "aec0aceb-a4db-49fb-b366-75e90229c640",
  • "actionCode": "string",
  • "chargeReference": 0,
  • "isDualMove": true
}

/api/PaymentOrchestration/AddEnvioPaymentFee

SecurityX-API-Key
Request
Request Body schema:
companyUId
string <uuid>
companyName
string or null
containerNumber
string or null
rateName
string or null
serviceOrderUId
string <uuid>
guaranteeThroughDate
string <date-time>
transactionId
string <uuid>
rateNames
Array of strings or null
feeAmount
number <double>
chargeId
string <uuid>
actionCode
string or null
chargeReference
integer <int32>
isDualMove
boolean
Responses
200

Success

post/api/PaymentOrchestration/AddEnvioPaymentFee
Request samples
{
  • "companyUId": "9b983c4f-7ae4-4765-8ec3-56a3d3042058",
  • "companyName": "string",
  • "containerNumber": "string",
  • "rateName": "string",
  • "serviceOrderUId": "4009d928-0f41-4b85-b577-2f40ea9fafaf",
  • "guaranteeThroughDate": "2019-08-24T14:15:22Z",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "rateNames": [
    ],
  • "feeAmount": 0,
  • "chargeId": "aec0aceb-a4db-49fb-b366-75e90229c640",
  • "actionCode": "string",
  • "chargeReference": 0,
  • "isDualMove": true
}

/api/PaymentOrchestration/AddEnvioAppointmentFee

SecurityX-API-Key
Request
Request Body schema:
companyUId
string <uuid>
companyName
string or null
containerNumber
string or null
rateName
string or null
serviceOrderUId
string <uuid>
guaranteeThroughDate
string <date-time>
transactionId
string <uuid>
rateNames
Array of strings or null
feeAmount
number <double>
chargeId
string <uuid>
actionCode
string or null
chargeReference
integer <int32>
isDualMove
boolean
Responses
200

Success

post/api/PaymentOrchestration/AddEnvioAppointmentFee
Request samples
{
  • "companyUId": "9b983c4f-7ae4-4765-8ec3-56a3d3042058",
  • "companyName": "string",
  • "containerNumber": "string",
  • "rateName": "string",
  • "serviceOrderUId": "4009d928-0f41-4b85-b577-2f40ea9fafaf",
  • "guaranteeThroughDate": "2019-08-24T14:15:22Z",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "rateNames": [
    ],
  • "feeAmount": 0,
  • "chargeId": "aec0aceb-a4db-49fb-b366-75e90229c640",
  • "actionCode": "string",
  • "chargeReference": 0,
  • "isDualMove": true
}

/api/PaymentOrchestration/AddThirdPartyFee

SecurityX-API-Key
Request
Request Body schema:
companyUId
string <uuid>
companyName
string or null
containerNumber
string or null
rateName
string or null
serviceOrderUId
string <uuid>
guaranteeThroughDate
string <date-time>
transactionId
string <uuid>
rateNames
Array of strings or null
feeAmount
number <double>
chargeId
string <uuid>
actionCode
string or null
chargeReference
integer <int32>
isDualMove
boolean
Responses
200

Success

post/api/PaymentOrchestration/AddThirdPartyFee
Request samples
{
  • "companyUId": "9b983c4f-7ae4-4765-8ec3-56a3d3042058",
  • "companyName": "string",
  • "containerNumber": "string",
  • "rateName": "string",
  • "serviceOrderUId": "4009d928-0f41-4b85-b577-2f40ea9fafaf",
  • "guaranteeThroughDate": "2019-08-24T14:15:22Z",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "rateNames": [
    ],
  • "feeAmount": 0,
  • "chargeId": "aec0aceb-a4db-49fb-b366-75e90229c640",
  • "actionCode": "string",
  • "chargeReference": 0,
  • "isDualMove": true
}

/api/PaymentOrchestration/GetThirdPartyFees/unitnumber/{unitnumber}/companyuid/{companyuid}

SecurityX-API-Key
Request
path Parameters
unitnumber
required
string
companyuid
required
string
query Parameters
status
string
Responses
200

Success

get/api/PaymentOrchestration/GetThirdPartyFees/unitnumber/{unitnumber}/companyuid/{companyuid}

/api/PaymentOrchestration/GetThirdPartyFees/{containerRefNumber}/{rateName}

SecurityX-API-Key
Request
path Parameters
containerRefNumber
required
string <uuid>
rateName
required
string
Responses
200

Success

get/api/PaymentOrchestration/GetThirdPartyFees/{containerRefNumber}/{rateName}

/api/PaymentOrchestration/ProcessThirdPartyFee

SecurityX-API-Key
Request
Request Body schema:
companyUId
string <uuid>
companyName
string or null
containerNumber
string or null
rateName
string or null
serviceOrderUId
string <uuid>
guaranteeThroughDate
string <date-time>
transactionId
string <uuid>
rateNames
Array of strings or null
feeAmount
number <double>
chargeId
string <uuid>
actionCode
string or null
chargeReference
integer <int32>
isDualMove
boolean
Responses
200

Success

post/api/PaymentOrchestration/ProcessThirdPartyFee
Request samples
{
  • "companyUId": "9b983c4f-7ae4-4765-8ec3-56a3d3042058",
  • "companyName": "string",
  • "containerNumber": "string",
  • "rateName": "string",
  • "serviceOrderUId": "4009d928-0f41-4b85-b577-2f40ea9fafaf",
  • "guaranteeThroughDate": "2019-08-24T14:15:22Z",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "rateNames": [
    ],
  • "feeAmount": 0,
  • "chargeId": "aec0aceb-a4db-49fb-b366-75e90229c640",
  • "actionCode": "string",
  • "chargeReference": 0,
  • "isDualMove": true
}