GET api/Payment?LoginKey={LoginKey}&BL={BL}

REturns the status of the BL in the Gemini System test OK2Pay field before activating a send or create button. OK2Pay can be Yes/No/Done. Only allow payment if Yes. if no, generate email to audit team?

Request Information

URI Parameters

NameDescriptionTypeAdditional information
LoginKey

string

Required

BL

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of PaymentStatus
NameDescriptionTypeAdditional information
BL

string

None.

AuditstatusUID

integer

None.

Total

decimal number

None.

Datestamp

string

None.

AuditStatus

string

None.

OK2Pay

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "BL": "sample string 1",
    "AuditstatusUID": 2,
    "Total": 3.1,
    "Datestamp": "sample string 4",
    "AuditStatus": "sample string 5",
    "OK2Pay": "sample string 6"
  },
  {
    "BL": "sample string 1",
    "AuditstatusUID": 2,
    "Total": 3.1,
    "Datestamp": "sample string 4",
    "AuditStatus": "sample string 5",
    "OK2Pay": "sample string 6"
  }
]

application/xml, text/xml

Sample:
<ArrayOfPaymentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeminiShippers.Common.RESTful">
  <PaymentStatus>
    <AuditStatus>sample string 5</AuditStatus>
    <AuditstatusUID>2</AuditstatusUID>
    <BL>sample string 1</BL>
    <Datestamp>sample string 4</Datestamp>
    <OK2Pay>sample string 6</OK2Pay>
    <Total>3.1</Total>
  </PaymentStatus>
  <PaymentStatus>
    <AuditStatus>sample string 5</AuditStatus>
    <AuditstatusUID>2</AuditstatusUID>
    <BL>sample string 1</BL>
    <Datestamp>sample string 4</Datestamp>
    <OK2Pay>sample string 6</OK2Pay>
    <Total>3.1</Total>
  </PaymentStatus>
</ArrayOfPaymentStatus>