Skip to content

Latest commit

 

History

History
158 lines (103 loc) · 4.7 KB

PayoutApi.md

File metadata and controls

158 lines (103 loc) · 4.7 KB
Raw

AdyenApiJs.PayoutApi

All URIs are relative to https://pal-test.adyen.com/pal/servlet

Method HTTP request Description
confirm POST /Payout/v30/confirmThirdParty Confirm a payout
decline POST /Payout/v30/declineThirdParty Decline a payout
storeDetailAndSubmit POST /Payout/v30/storeDetailAndSubmitThirdParty Store the payouts details and make a payout request

confirm

ConfirmOrDeclineResult confirm(confirmOrDeclineRequest)

Confirm a payout

You can decide over a period of seven days to proceed a payout, after which the payout expires automatically

Example

var AdyenApiJs = require('adyen-api-js');
var defaultClient = AdyenApiJs.ApiClient.instance;

// Configure HTTP basic authorization: auth
var auth = defaultClient.authentications['auth'];
auth.username = 'YOUR USERNAME';
auth.password = 'YOUR PASSWORD';

var apiInstance = new AdyenApiJs.PayoutApi();

var confirmOrDeclineRequest = new AdyenApiJs.ConfirmOrDeclineRequest(); // ConfirmOrDeclineRequest | The confirm or decline payout request

apiInstance.confirm(confirmOrDeclineRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
confirmOrDeclineRequest ConfirmOrDeclineRequest The confirm or decline payout request

Return type

ConfirmOrDeclineResult

Authorization

auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

decline

ConfirmOrDeclineResult decline(confirmOrDeclineRequest)

Decline a payout

You can decide over a period of seven days to cancel a payout, after which the payout expires automatically.

Example

var AdyenApiJs = require('adyen-api-js');
var defaultClient = AdyenApiJs.ApiClient.instance;

// Configure HTTP basic authorization: auth
var auth = defaultClient.authentications['auth'];
auth.username = 'YOUR USERNAME';
auth.password = 'YOUR PASSWORD';

var apiInstance = new AdyenApiJs.PayoutApi();

var confirmOrDeclineRequest = new AdyenApiJs.ConfirmOrDeclineRequest(); // ConfirmOrDeclineRequest | The confirm or decline payout request

apiInstance.decline(confirmOrDeclineRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
confirmOrDeclineRequest ConfirmOrDeclineRequest The confirm or decline payout request

Return type

ConfirmOrDeclineResult

Authorization

auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

storeDetailAndSubmit

StoreDetailAndSubmitResult storeDetailAndSubmit(storeDetailAndSubmitRequest)

Store the payouts details and make a payout request

Besides storing payout details using the normal payment flow, the payout web service offers a call to store payout details, either bank account or credit card, for a specific shopper and make a payout request in a single API call.

Example

var AdyenApiJs = require('adyen-api-js');
var defaultClient = AdyenApiJs.ApiClient.instance;

// Configure HTTP basic authorization: auth
var auth = defaultClient.authentications['auth'];
auth.username = 'YOUR USERNAME';
auth.password = 'YOUR PASSWORD';

var apiInstance = new AdyenApiJs.PayoutApi();

var storeDetailAndSubmitRequest = new AdyenApiJs.StoreDetailAndSubmitRequest(); // StoreDetailAndSubmitRequest | The store detail and submit Request

apiInstance.storeDetailAndSubmit(storeDetailAndSubmitRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
storeDetailAndSubmitRequest StoreDetailAndSubmitRequest The store detail and submit Request

Return type

StoreDetailAndSubmitResult

Authorization

auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json