v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Settlement Accounts

Get a settlement account transaction

The GET /virtual-accounts/{accountId}/transactions/{providerPaymentId} endpoint retrieves information for a specific transaction in a given settlement account.

get/virtual-accounts/{accountId}/transactions/{providerPaymentId}

Path parameters

accountIdstring required

The system-generated, unique id which specifies the settlement account.

providerPaymentIdstring required

The settlement account provider-assigned unique transaction identifier.

Query parameters

onBehalfOfIdstring

Filters payments by the onBehalfOfId value - returns only payments with onBehalfOfId specified in this parameter. This field is mandatory for unregulated TPPs.

Response

Successful response

Example response

{
  "transaction": {
    "amount": {
      "currency": "EUR",
      "value": "10.23"
    },
    "providerPaymentId": "83KiRJuXm",
    "createdDateTime": "2017-04-05T10:43:07.000+00:00",
    "description": "Payment",
    "localInstrument": "SEPA_INSTANT",
    "debtor": {
      "iban": "GB29NWBK60161331926819",
      "bic": "BOFIIE2D",
      "address": {
        "addressLine": [
          "The Coach House"
        ],
        "streetName": "221B",
        "buildingNumber": "2C",
        "postCode": "TR26 1EZ",
        "townName": "Saint Ives",
        "state": "Cornwall",
        "country": "GB"
      }
    },
    "creditor": {
      "iban": "GB29NWBK60161331926819",
      "bic": "BOFIIE2D",
      "name": "Customer Inc.",
      "ultimateCreditorName": "Customer Inc.",
      "address": {
        "addressLine": [
          "The Coach House"
        ],
        "streetName": "221B",
        "buildingNumber": "2C",
        "postCode": "TR26 1EZ",
        "townName": "Saint Ives",
        "state": "Cornwall",
        "country": "GB"
      }
    },
    "refId": "9htio4a1sp2akdr1aa",
    "transferId": "t:2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV",
    "paymentId": "pm2:2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV",
    "refundId": "rf:2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV",
    "payoutId": "po:2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV"
  }
}