Making a test payment: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
(first iteration. to-do: images, json formatting)
 
(fixed code block)
Line 13: Line 13:
# Log in to [https://secure.test.barion.com to your Barion shop].
# Log in to [https://secure.test.barion.com to your Barion shop].
# Click through to Shops>Actions>Details>Secret Key (POSKey), and copy the value to the clipboard.  [[File:/img/getting-started/posKey-1.png|Finding your shop’s POSKey]] ''Finding your shop’s POSKey''
# Click through to Shops>Actions>Details>Secret Key (POSKey), and copy the value to the clipboard.  [[File:/img/getting-started/posKey-1.png|Finding your shop’s POSKey]] ''Finding your shop’s POSKey''
# Start the Postman Desktop agent, and make a POST call to <code>https://api.test.barion.com/v2/payment/start</code>, passing the following JSON in the request body:  Replace the <code>POSKey</code> and the <code>Transactions</code>/<code>Payee</code> as indicated.<pre>{
# Start the Postman Desktop agent, and make a POST call to <code>https://api.test.barion.com/v2/payment/start</code>, passing the following JSON in the request body:  Replace the <code>POSKey</code> and the <code>Transactions</code>/<code>Payee</code> as indicated.
     &quot;POSKey&quot;: &quot;[the POSKey you've just copied]&quot;,
<syntaxhighlight lang="json">{
     &quot;PaymentType&quot;: &quot;Immediate&quot;,
     "POSKey": "[the POSKey you've just copied]",
     &quot;PaymentRequestId&quot;: &quot;DEV-TEST-615&quot;,
     "PaymentType": "Immediate",
     &quot;FundingSources&quot;: [&quot;All&quot;],
     "PaymentRequestId": "DEV-TEST-615",
     &quot;OrderNumber&quot;: &quot;Order_01&quot;,
     "FundingSources": ["All"],
     &quot;RedirectUrl&quot;: &quot;https://example.com/&quot;,
     "OrderNumber": "Order_01",
     &quot;Currency&quot;: &quot;EUR&quot;,
     "RedirectUrl": "https://example.com/",
     &quot;Locale&quot;:&quot;en-US&quot;,
     "Currency": "EUR",
     &quot;GuestCheckOut&quot;: true,
     "Locale":"en-US",
     &quot;PaymentWindow&quot;:&quot;00:30:00&quot;,
     "GuestCheckOut": true,
     &quot;Transactions&quot;: [
     "PaymentWindow":"00:30:00",
     "Transactions": [
         {
         {
             &quot;POSTransactionId&quot;: &quot;DEV-TEST-01-01&quot;,
             "POSTransactionId": "DEV-TEST-01-01",
             &quot;Payee&quot;: [the email address associated with the Barion shop],
             "Payee": "[the email address associated with the Barion shop]",
             &quot;Total&quot;: 100,
             "Total&quot;: 100,
             &quot;Comment&quot;: &quot;Test transaction&quot;,
             "Comment": "Test transaction",
             &quot;Items&quot;: [
             "Items": [
                 {
                 {
                     &quot;Name&quot;: &quot;Nada&quot;,
                     "Name": "Nada",
                     &quot;Description&quot;: &quot;Zilch&quot;,
                     "Description": "Zilch",
                     &quot;Quantity&quot;: 1,
                     "Quantity": 1,
                     &quot;Unit&quot;: &quot;db&quot;,
                     "Unit": "db",
                     &quot;UnitPrice&quot;: 1,
                     "UnitPrice": 1,
                     &quot;ItemTotal&quot;: 1,
                     "ItemTotal": 1,
                     &quot;SKU&quot;: &quot;SM-01&quot;
                     "SKU": "SM-01"
                 }
                 }
             ]
             ]
         }
         }
     ]
     ]
}</pre>For details on the various parameters you’re passing in the call, see [[05-api-reference/01-payment-resource/01-payment-start|the <code>Payment/Start</code> API endpoint reference]].<blockquote>Step result:  The API request returns the following JSON:  <br />{  "PaymentId": [the payment ID generated for the transaction],  "PaymentRequestId": "DEV-TEST-187",  "Status": "Prepared",  "QRUrl": "<nowiki>https://api.test.barion.com/qr/generate?paymentId=</nowiki>[the payment ID generated for the transaction]&size=Large",  "Transactions": [  {  "POSTransactionId": "DEV-TEST-01-01",  "TransactionId": [the payment ID generated for the transaction],  "Status": "Prepared",  "Currency": "EUR",  "TransactionTime": "0001-01-01T00:00:00",  "RelatedId": null  }  ],  "RecurrenceResult": "None",  "ThreeDSAuthClientData": null,  "GatewayUrl": "<nowiki>https://secure.test.barion.com/Pay?Id=2</nowiki>[the payment ID generated for the transaction]",  "RedirectUrl": "<nowiki>http://barion.com/?paymentId=</nowiki>[the payment ID generated for the transaction]",  "CallbackUrl": "",  "TraceId": null,  "Errors": []  }</blockquote>
}</syntaxhighlight>For details on the various parameters you’re passing in the call, see [[05-api-reference/01-payment-resource/01-payment-start|the <code>Payment/Start</code> API endpoint reference]].<blockquote>Step result:  The API request returns the following JSON:  <br /><syntaxhighlight lang="json">{  "PaymentId": [the payment ID generated for the transaction],  "PaymentRequestId": "DEV-TEST-187",  "Status": "Prepared",  "QRUrl": "<nowiki>https://api.test.barion.com/qr/generate?paymentId=</nowiki>[the payment ID generated for the transaction]&size=Large",  "Transactions": [  {  "POSTransactionId": "DEV-TEST-01-01",  "TransactionId": [the payment ID generated for the transaction],  "Status": "Prepared",  "Currency": "EUR",  "TransactionTime": "0001-01-01T00:00:00",  "RelatedId": null  }  ],  "RecurrenceResult": "None",  "ThreeDSAuthClientData": null,  "GatewayUrl": "<nowiki>https://secure.test.barion.com/Pay?Id=2</nowiki>[the payment ID generated for the transaction]",  "RedirectUrl": "<nowiki>http://barion.com/?paymentId=</nowiki>[the payment ID generated for the transaction]",  "CallbackUrl": "",  "TraceId": null,  "Errors": []  }</syntaxhighlight></blockquote>


== Pay through the Barion Smart Gateway: ==
== Pay through the Barion Smart Gateway: ==

Revision as of 04:27, 7 August 2024

Get a feel for how Barion works by using the Barion Gateway API to

  1. set up a payment for the Barion shop you’ve created, and
  2. settle the payment with some test money from your Barion Wallet.

Prerequisites

Make a test payment using the Barion API

  1. Log in to to your Barion shop.
  2. Click through to Shops>Actions>Details>Secret Key (POSKey), and copy the value to the clipboard. Finding your shop’s POSKey Finding your shop’s POSKey
  3. Start the Postman Desktop agent, and make a POST call to https://api.test.barion.com/v2/payment/start, passing the following JSON in the request body: Replace the POSKey and the Transactions/Payee as indicated.
{
    "POSKey": "[the POSKey you've just copied]",
    "PaymentType": "Immediate",
    "PaymentRequestId": "DEV-TEST-615",
    "FundingSources": ["All"],
    "OrderNumber": "Order_01",
    "RedirectUrl": "https://example.com/",
    "Currency": "EUR",
    "Locale":"en-US",
    "GuestCheckOut": true,
    "PaymentWindow":"00:30:00",
    "Transactions": [
        {
            "POSTransactionId": "DEV-TEST-01-01",
            "Payee": "[the email address associated with the Barion shop]",
            "Total&quot;: 100,
            "Comment": "Test transaction",
            "Items": [
                {
                    "Name": "Nada",
                    "Description": "Zilch",
                    "Quantity": 1,
                    "Unit": "db",
                    "UnitPrice": 1,
                    "ItemTotal": 1,
                    "SKU": "SM-01"
                }
            ]
        }
    ]
}

For details on the various parameters you’re passing in the call, see the Payment/Start API endpoint reference.

Step result: The API request returns the following JSON:

{  "PaymentId": [the payment ID generated for the transaction],  "PaymentRequestId": "DEV-TEST-187",  "Status": "Prepared",  "QRUrl": "<nowiki>https://api.test.barion.com/qr/generate?paymentId=</nowiki>[the payment ID generated for the transaction]&size=Large",  "Transactions": [  {  "POSTransactionId": "DEV-TEST-01-01",  "TransactionId": [the payment ID generated for the transaction],  "Status": "Prepared",  "Currency": "EUR",  "TransactionTime": "0001-01-01T00:00:00",  "RelatedId": null  }  ],  "RecurrenceResult": "None",  "ThreeDSAuthClientData": null,  "GatewayUrl": "<nowiki>https://secure.test.barion.com/Pay?Id=2</nowiki>[the payment ID generated for the transaction]",  "RedirectUrl": "<nowiki>http://barion.com/?paymentId=</nowiki>[the payment ID generated for the transaction]",  "CallbackUrl": "",  "TraceId": null,  "Errors": []  }

Pay through the Barion Smart Gateway:

Go to the URL in the POST call’s GatewayURL return value, and complete the purchase using the following test card details:

  • Card number: 4444 8888 8888 5559
  • Expiration date: any future date
  • CVC: any 3-digit number

![The Test Payment Gateway for Your API-prompted Transaction](/img/getting-started/gatewayUrl.png) *The Test Payment Gateway for Your API-prompted Transaction*

Next steps