Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Description

The executeXpay request will open a new xPay transaction according to your company balance and currency.

URL: https://secure1.sandbox.directpay.online/API/v6/

Response

The method will response with the result of your request


Variables to send:

Parameter

Data type

Description


 Request

 Text

 executeXpay

Mandatory

CompanyToken

Token

Token you got from 3G to operate this API

Mandatory

ProviderToken

Token

Api token of provider you retrieve his services.

Mandatory

Amount

Money

Total amount in currency selected.

Mandatory

Currency

Text

From table of options as accepted from 3G.

Mandatory

Services

Number

Service type number according to the options accepted from 3G.

Mandatory

Description

Text

The description of the payment made.

Mandatory

Request example:


request example
<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <Request>executeXpay</Request>
  <CompanyToken>68B90B5E-25F6-4146-8AB1-C7A3A0C41A7F</CompanyToken>
  <ProviderToken>CA55CE70-770B-4DFC-BBD0-D02117914C5D</ProviderToken>
  <Allocations>
	  <Allocation>
		  <ProviderToken>DCBD0E43-1AE6-4758-8641-3B7A7D52ABCD</ProviderToken>
		  <Amount>2</Amount>
		  <Currency>USD</Currency>
		  <Service>6264</Service>
		  <Description>Payment for flight</Description>
	  </Allocation>
	   <Allocation>
		  <ProviderToken>47DB152F-4A29-44F2-ADE1-3B7A7D52ABCD</ProviderToken>
		  <Amount>1</Amount>
		  <Currency>USD</Currency>
		  <Service>202</Service>
		  <Description>Payment for flight</Description>
	  </Allocation>
  </Allocations>
</API3G>


Respond:

The server will respond for the executeXpay request according to the following results:

Parameter

Data type

Description

Result

3 digits code

If the operation succeed

ResultExplanation

Text

ID of your new Xpay transaction

RequestRefTokenRequest refrence
AllocationIdNumberCreate xPay ID

Respond example:


response example
<?xml version="1.0" encoding="utf-8"?>
<API3G>
    <Result>000</Result>
    <ResultExplanation>Success</ResultExplanation>
    <RequestRef>9FBC03E2-F289-4E9E-A5AE-0191697149A9</RequestRef>
    <Allocations>
      <Allocation>
         <AllocationId>12345</AllocationId>
      </Allocation>
    </Allocations>
</API3G>





  • No labels