BokaMera.API.Host

<back to all web services

SendCheckoutPaymentRequest

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/payment/payson/v2/checkout/{Id}/sendpaymentrequestIf checkout has is awaiting admin to send payment request, this method is sending the payment reqeust (example when you want to send the payment request manually).
SendCheckoutPaymentRequest Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdpathGuidYesThe checkout id. The checkout must have status ReadyToShip - 5
PaysonCheckoutV2Response Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNoThe checkout id
SnippetformstringNoThe code snippet to for checkout module
StatusformPayson2CheckoutStatusNoThe checkout status
Payson2CheckoutStatus Enum:
None
Created
FormsFilled
ReadyToPay
ProcessingPayment
ReadyToShip
Shipped
PaidToAccount
Canceled
Credited
Expired
Denied

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /payment/payson/v2/checkout/{Id}/sendpaymentrequest HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendCheckoutPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Id>00000000-0000-0000-0000-000000000000</Id>
</SendCheckoutPaymentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaysonCheckoutV2Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Snippet>String</Snippet>
  <Status>None</Status>
</PaysonCheckoutV2Response>