Get Payment Beneficiaries List | More APIs

GET /v1/payments/stored-beneficiaries

Query Parameters

No query parameters.

Request headers

Attribute	Type	Condition	Description
X-Request-ID	UUID	Mandatory	ID of the request, unique to the call, as determined by the initiating party (TPP)
Authorization	String	Mandatory	The oAuth2 Bearer token obtained from the performed SCA performed prior to this request.
PSU-IP-Address	String	Mandatory	The forwarded IP address header field consists of the corresponding http request IP address field between PSU and TPP
Consent-ID	UUID	Mandatory	The consent ID of the related AIS consent.
PSU-IP-Port	String	Optional	The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
PSU-Device-ID	UUID	Optional	UUID (Universally Unique Identifier) for a device, which is used by the PSU if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device
PSU-Geo-Location	String	Optional	The forwarded Geo Location of the corresponding http request between PSU and TPP if available

Response Code

HTTP Response Code 200 (OK).

Response headers

Attribute	Type	Condition	Description
Location	String	Mandatory	Location of the crated resource (if created)
X-Request-ID	UUID	Mandatory	ID of the request, unique to the call, as determined by the initiating party (TPP)

Response body

Attribute	Type	Condition	Description
beneficiaries	List of Payment Beneficiary	Mandatory	A list of Payment Benefiary objects.
pagination	Pagination	Mandatory	Pagination information about the returned results.

Example

Request

curl -X GET \
https://mp-psd2-api.mypos.com/v1/payments/stored-beneficiaries \
-H 'API-Key: aGDmxHAmpMWUL1txqCsjEcOS' \
-H 'Authorization: Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X' \
-H 'TPP-Signature-Certificate: ...' \
-H 'Signature: ...' \
-H 'Digest: SHA256' \
-H 'X-Request-ID: a552babc-7081-44e7-9361-61eb17e0bfd9' \
-d '{}'

import requests

url = "https://mp-psd2-api.mypos.com/v1/payments/sepa-credit-transfers"
payload = dict()

headers = {
    'API-Key': "aGDmxHAmpMWUL1txqCsjEcOS",
    'Authorization': "Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X",
    'X-Request-ID': "a552babc-7081-44e7-9361-61eb17e0bfd9",
    'TPP-Signature-Certificate': '...',
    'Signature': '...',
    'Digest': 'SHA256'
}

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

var request = require("request");

var options = { method: 'GET',
  url: 'https://mp-psd2-api.mypos.com/v1/payments/sepa-credit-transfers',
  headers: {
    'Authorization': 'Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X',
    'TPP-Signature-Certificate': '...',
    'Signature': '...',
    'Digest': 'SHA256',
    'X-Request-ID': 'a552babc-7081-44e7-9361-61eb17e0bfd9',
    'API-Key': 'aGDmxHAmpMWUL1txqCsjEcOS'
  },
  form: { }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

<?php

$request = new HttpRequest();
$request->setUrl('https://mp-psd2-api.mypos.com/v1/payments/sepa-credit-transfers');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'Authorization' => 'Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X',
  'TPP-Signature-Certificate' => '...',
  'Signature' => '...',
  'Digest' => 'SHA256',
  'X-Request-ID' => 'a552babc-7081-44e7-9361-61eb17e0bfd9',
  'TPP-Redirect-URI' => 'https://test.com',
  'API-Key' => 'aGDmxHAmpMWUL1txqCsjEcOS'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

Response

{
    "paymentId": "e454aa67-2829-49da-a4e3-9fbcdd6e7545",
    "paymentStatus": "RCVD",
    "_links": {
        "self": {
            "href": "/v1/payments/cross-border-credit-transfers/e454aa67-2829-49da-a4e3-9fbcdd6e7545"
        },
        "status": {
            "href": "/v1/payments/cross-border-credit-transfers/e454aa67-2829-49da-a4e3-9fbcdd6e7545/status"
        },
        "scaStatus": {
            "href": "v1/consents/3c7816ee-3d51-4bf5-8ced-ece2af35d431/status"
        },
        "scaOAuth": {
            "href": "https://www.mypos.com?open_bank_payment_id=e454aa67-2829-49da-a4e3-9fbcdd6e7545"
        }
    }
}