POST v{version}/{lang}/PaypalSubmit?currency={currency}&wp={wp}

Submit Paypal data.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
lang

string

Required

currency

string

Default value is ISK

wp

string

Default value is GG

version

The requested API version

string

Required

Default value is 1.0

Body Parameters

PaypalSubmitRequest
NameDescriptionTypeAdditional information
Nonce

string

None.

AccountType

AccountType

None.

Request Formats

application/json, text/json

Sample:
{
  "Nonce": "sample string 1",
  "AccountType": 0
}

application/xml, text/xml

Sample:
<PaypalSubmitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adventures.WidgetAPI.Core.Models.Paypal">
  <AccountType>Canada</AccountType>
  <Nonce>sample string 1</Nonce>
</PaypalSubmitRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ConfirmPaypalPaymentResult
NameDescriptionTypeAdditional information
Status

ConfirmPaymentResultStatus

None.

Message

string

None.

BookRequest

BookRequest

None.

BookResult

BookResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "Message": "sample string 1",
  "BookRequest": {
    "TotalAmount": 1.0,
    "Amount": 1.0,
    "Currency": "sample string 2",
    "AmountPaid": 1.0,
    "CurrencyPaid": "sample string 3",
    "AuthCode": "sample string 4",
    "CardNumber": "sample string 5",
    "PaymentType": "sample string 6",
    "TransactionId": "sample string 7",
    "TransactionDate": "2025-04-10T07:14:03.7033137+00:00",
    "Token": "sample string 8",
    "Comment": "sample string 9",
    "DepositPayment": true,
    "GiftCards": [
      {
        "Id": 1,
        "Code": "sample string 1",
        "AmountAvailable": 2.0,
        "AmountUsed": 3.0,
        "Currency": "sample string 4",
        "TransactionId": "sample string 5"
      },
      {
        "Id": 1,
        "Code": "sample string 1",
        "AmountAvailable": 2.0,
        "AmountUsed": 3.0,
        "Currency": "sample string 4",
        "TransactionId": "sample string 5"
      }
    ],
    "AcceptsMarketing": true
  },
  "BookResult": {
    "Success": true,
    "Proceed": true,
    "ConfirmationCode": "sample string 3",
    "Message": "sample string 4",
    "ClientMessage": "sample string 5",
    "ApiStatusCode": 1
  }
}

application/xml, text/xml

Sample:
<ConfirmPaypalPaymentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adventures.WidgetAPI.Core.Models.Paypal">
  <BookRequest xmlns:d2p1="http://schemas.datacontract.org/2004/07/Adventures.WidgetAPI.Core.Models">
    <d2p1:AcceptsMarketing>true</d2p1:AcceptsMarketing>
    <d2p1:Amount>1</d2p1:Amount>
    <d2p1:AmountPaid>1</d2p1:AmountPaid>
    <d2p1:AuthCode>sample string 4</d2p1:AuthCode>
    <d2p1:CardNumber>sample string 5</d2p1:CardNumber>
    <d2p1:Comment>sample string 9</d2p1:Comment>
    <d2p1:Currency>sample string 2</d2p1:Currency>
    <d2p1:CurrencyPaid>sample string 3</d2p1:CurrencyPaid>
    <d2p1:DepositPayment>true</d2p1:DepositPayment>
    <d2p1:GiftCards xmlns:d3p1="http://schemas.datacontract.org/2004/07/Adventures.WidgetAPI.Core.Models.Widget">
      <d3p1:WidgetGiftCardDto>
        <d3p1:AmountAvailable>2</d3p1:AmountAvailable>
        <d3p1:AmountUsed>3</d3p1:AmountUsed>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:Currency>sample string 4</d3p1:Currency>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:TransactionId>sample string 5</d3p1:TransactionId>
      </d3p1:WidgetGiftCardDto>
      <d3p1:WidgetGiftCardDto>
        <d3p1:AmountAvailable>2</d3p1:AmountAvailable>
        <d3p1:AmountUsed>3</d3p1:AmountUsed>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:Currency>sample string 4</d3p1:Currency>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:TransactionId>sample string 5</d3p1:TransactionId>
      </d3p1:WidgetGiftCardDto>
    </d2p1:GiftCards>
    <d2p1:PaymentType>sample string 6</d2p1:PaymentType>
    <d2p1:Token>sample string 8</d2p1:Token>
    <d2p1:TotalAmount>1</d2p1:TotalAmount>
    <d2p1:TransactionDate>2025-04-10T07:14:03.7033137+00:00</d2p1:TransactionDate>
    <d2p1:TransactionId>sample string 7</d2p1:TransactionId>
  </BookRequest>
  <BookResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/Adventures.WidgetAPI.Core.Models">
    <d2p1:ApiStatusCode>1</d2p1:ApiStatusCode>
    <d2p1:ClientMessage>sample string 5</d2p1:ClientMessage>
    <d2p1:ConfirmationCode>sample string 3</d2p1:ConfirmationCode>
    <d2p1:Message>sample string 4</d2p1:Message>
    <d2p1:Proceed>true</d2p1:Proceed>
    <d2p1:Success>true</d2p1:Success>
  </BookResult>
  <Message>sample string 1</Message>
  <Status>NOT_FOUND</Status>
</ConfirmPaypalPaymentResult>