Gateway API

The Gateway API component is intended for B2B interfaces it supports REST calls which can board new merchants and request payouts, etc. Most requests are authenticated with the callers merchant or partner API key.

C#PHPNodeShell

Scroll down for code samples, example requests and responses.
Select a language for code samples from the tabs or the mobile navigation menu.

List payouts for date range

GET /report/v1/payouts

Parameters

Authorizationstringrequired
Partner API key
merchantNumberinteger (int64)optional
Used with Partner api key
currencystringoptional
ISO 4217 currency code
fromDatestring (date)required
datetime in ISO format, fx. 2018-01-01
toDatestring (date)required
datetime in ISO format, fx. 2018-12-31
pageNumberinteger (int32)optional
pageSizeinteger (int32)optional

List payouts for date range

C#
PHP
Node
Shell

var client = new RestClient("https://gateway.pp.easyportal.nets.eu/report/v1/payouts?merchantNumber=SOME_INTEGER_VALUE&currency=SOME_STRING_VALUE&fromDate=SOME_STRING_VALUE&toDate=SOME_STRING_VALUE&pageNumber=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200SUCCESSoptional
- numberOfPayoutsinteger (int32)optional
- payoutsarrayoptional
  - idstringoptional
  - referencestringoptional
    Reference used on bank account statement
  - datestring (date)optional
    Date-time format (RFC3339)
  - bankAccountIbanstringoptional
  - bankAccountBicstringoptional
  - currencystringoptional
    ISO4217 3-alpha code
  - amountinteger (int64)optional
    in minor units of currency
  - chargedAmountinteger (int64)optional
    in minor units of currency
  - numberOfChargesinteger (int64)optional
  - refundedAmountinteger (int64)optional
    in minor units of currency
  - numberOfRefundsinteger (int64)optional
  - depositedAmountinteger (int64)optional
    in minor units of currency
  - numberOfDepositsinteger (int64)optional
  - feesinteger (int64)optional
    in minor units of currency
  - feeVATpercentinteger (int64)deprecated
  - feeTaxRateinteger (int64)optional
    Always 0 ,replaces feeVATpercent
  - feeTaxAmountinteger (int64)optional
    Always 0
  - transactionTaxDetailsarrayoptional
    rateinteger (int64)optional
    taxRate format (2500 for 25%)
    amountinteger (int64)optional
    in minor units of currency
400Bad Requestoptional
401Unauthorizedoptional
404Resource Not Foundoptional
500Unexpected Erroroptional

{
    "numberOfPayouts": 0,
    "payouts": [
        {
            "id": "string",
            "reference": "string",
            "date": "2019-08-24",
            "bankAccountIban": "string",
            "bankAccountBic": "string",
            "currency": "string",
            "amount": 0,
            "chargedAmount": 0,
            "numberOfCharges": 0,
            "refundedAmount": 0,
            "numberOfRefunds": 0,
            "depositedAmount": 0,
            "numberOfDeposits": 0,
            "fees": 0,
            "feeVATpercent": 0,
            "feeTaxRate": 0,
            "feeTaxAmount": 0,
            "transactionTaxDetails": [
                {
                    "rate": 0,
                    "amount": 0
                }
            ]
        }
    ]
}

PayoutDetails for payoutId

GET /report/v1/payouts/{id}

Parameters

Authorizationstringrequired
Partner API key
idstringrequired
Id of needed Payout
merchantNumberinteger (int64)required
Used with Partner api key
pageNumberinteger (int32)optional
pageSizeinteger (int32)optional

PayoutDetails for payoutId

C#
PHP
Node
Shell

var client = new RestClient("https://gateway.pp.easyportal.nets.eu/report/v1/payouts/{id}?merchantNumber=SOME_INTEGER_VALUE&pageNumber=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200SUCCESSoptional
- idstringoptional
- referencestringoptional
  Reference used on bank account statement
- datestringoptional
  Date-time format (RFC3339)
- bankAccountIbanstringoptional
- bankAccountBicstringoptional
- currencystringoptional
  ISO4217 3-alpha code
- amountinteger (int64)optional
  in minor units of currency
- chargedAmountinteger (int64)optional
  in minor units of currency
- refundedAmountinteger (int64)optional
  in minor units of currency
- depositedAmountinteger (int64)optional
  in minor units of currency
- feesinteger (int64)optional
  in minor units of currency
- feeVATpercentinteger (int64)deprecated
- feeTaxRateinteger (int64)optional
  replaces feeVATpercent
- feeTaxAmountinteger (int64)optional
- transactionTaxDetailsarrayoptional
  - rateinteger (int64)optional
    taxRate format (2500 for 25%)
  - amountinteger (int64)optional
    in minor units of currency
- numberOfPaymentActionsinteger (int32)optional
  the total number of payment actions in this settlement
- paymentActionsarrayoptional
  - idstringoptional
    Payment Action Id
  - paymentIdstringoptional
  - paymentActionstringoptional
    CHARGE, REFUND, DEPOSIT, CHARGEBACK, ADJUSTMENT, FEES
  - paymentMethodstringoptional
  - paymentTypestringoptional
  - timestampstring (date-time)optional
    date-time format (RFC3339)
  - referencestringoptional
  - invoiceNumberstringoptional
  - amountinteger (int64)optional
    in minor units of currency
  - vatAmountinteger (int64)deprecated
    in minor units of currency
  - currencystringoptional
    ISO4217 3-alpha code
  - feeinteger (int64)optional
    in minor units of currency
  - flexibleFeeinteger (int64)optional
  - fixedFeeinteger (int64)optional
  - feeVATpercentinteger (int64)deprecated
  - feeTaxRateinteger (int64)optional
    Always 0 ,replaces feeVATpercent
  - feeTaxAmountinteger (int64)optional
    Always 0
  - transactionTaxDetailsarrayoptional
    rateinteger (int64)optional
    taxRate format (2500 for 25%)
    amountinteger (int64)optional
    in minor units of currency
  - subscriptionIdstringoptional
  - myReferencestringoptional
  - transactionPayoutReferencestringoptional
  - feeTypestringoptional
  - transactionAmountinteger (int64)optional
400Bad Requestoptional
401Unauthorizedoptional
404Resource Not Foundoptional
500Unexpected Erroroptional

{
    "id": "string",
    "reference": "string",
    "date": "string",
    "bankAccountIban": "string",
    "bankAccountBic": "string",
    "currency": "string",
    "amount": 0,
    "chargedAmount": 0,
    "refundedAmount": 0,
    "depositedAmount": 0,
    "fees": 0,
    "feeVATpercent": 0,
    "feeTaxRate": 0,
    "feeTaxAmount": 0,
    "transactionTaxDetails": [
        {
            "rate": 0,
            "amount": 0
        }
    ],
    "numberOfPaymentActions": 0,
    "paymentActions": [
        {
            "id": "string",
            "paymentId": "string",
            "paymentAction": "CHARGE",
            "paymentMethod": "string",
            "paymentType": "string",
            "timestamp": "2019-08-24T14:15:22Z",
            "reference": "string",
            "invoiceNumber": "string",
            "amount": 0,
            "vatAmount": 0,
            "currency": "string",
            "fee": 0,
            "flexibleFee": 0,
            "fixedFee": 0,
            "feeVATpercent": 0,
            "feeTaxRate": 0,
            "feeTaxAmount": 0,
            "transactionTaxDetails": [
                {
                    "rate": 0,
                    "amount": 0
                }
            ],
            "subscriptionId": "string",
            "myReference": "string",
            "transactionPayoutReference": "string",
            "feeType": "string",
            "transactionAmount": 0
        }
    ]
}