Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Payments v2

Get payments

The GET /v2/payments endpoint provides you with a list of payments and their details.

get/v2/payments

Query parameters

limitinteger required

The maximum number of records to return.

offsetstring

The offset from the previous page.

idsstring[]

Filters payments by their ids - returns only payments with ids listed in this parameter.

invertIdsboolean

Invert ids query - returns only payments with ids not listed in the ids parameter.

statusesPaymentStatus[]

Filters payments by their statuses - returns only payments with statuses listed in this parameter. For VRP payments (when type=VARIABLE_RECURRING_PAYMENT), only the following PaymentStatus values are supported:<br/>• INITIATION_PENDING<br/>• INITIATION_PROCESSING<br/>• INITIATION_COMPLETED<br/>• INITIATION_REJECTED<br/>• INITIATION_REJECTED_INSUFFICIENT_FUNDS<br/>• INITIATION_FAILED<br/>• INITIATION_NO_FINAL_STATUS_AVAILABLE<br/>Using unsupported statuses for VRP payments will result in an error.<br/><br/>For single immediate payments, all PaymentStatus values are supported.

[
  "INITIATION_COMPLETED"
]
invertStatusesboolean

Invert statuses query - returns only payments with statuses not listed in the statuses parameter.

createdAfterstring

Returns only payments created after this time (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).

createdBeforestring

Returns only payments created before this time (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).

refIdsstring[]

Filters payments by their refId values - returns only payments with refIds listed in this parameter.

onBehalfOfIdstring

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

refundStatusesPaymentRefundStatus[]

Filters payments by their refund status values - returns only payments with refund statuses listed in this parameter. Not supported for Vrp.

[
  "NONE"
]
partialboolean

Returns payments in a partial format - with only id and status fields populated.

externalPsuReferencestring

An external reference provided by the TPP (Third Party Provider) to uniquely identify the PSU (Payment Service User).

Example:psu external reference 12345
type'SINGLE_IMMEDIATE_PAYMENT' | 'VARIABLE_RECURRING_PAYMENT'
Example:SINGLE_IMMEDIATE_PAYMENT

Filter by payment type - single immediate or variable recurring payment. Defaults to SINGLE_IMMEDIATE_PAYMENT if not specified.

vrpConsentIdstring

Filter by Vrp consent id value. Only applied if type is VARIABLE_RECURRING_PAYMENT.

Response

Successful response

Example response

{
  "payments": [
    {
      "id": "pm:12345abcd:abcd",
      "memberId": "m:123456abcd:abcd",
      "initiation": {
        "bankId": "ob-modelo",
        "refId": "9htio4a1sp2akdr1aa",
        "remittanceInformationPrimary": "Sweepco",
        "remittanceInformationSecondary": "Secondary remittance information.",
        "onBehalfOfId": "c5a863bc-86f2-4418-a26f-25b24c7983c7",
        "amount": {
          "value": "10.23",
          "currency": "EUR"
        },
        "localInstrument": "SEPA",
        "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"
          }
        },
        "executionDate": "2023-04-29",
        "returnTokenizedAccount": true,
        "callbackUrl": "https://tpp.com/callback",
        "callbackState": "6242e45e-3063-4c42-8376",
        "chargeBearer": "CRED",
        "risk": {
          "psuId": "0000789123",
          "paymentContextCode": "PISP_PAYEE",
          "paymentPurposeCode": "DVPM",
          "merchantCategoryCode": "4812",
          "beneficiaryAccountType": "BUSINESS",
          "contractPresentIndicator": true,
          "beneficiaryPrepopulatedIndicator": true,
          "deliveryAddress": {
            "addressLine": [
              "Flat 2, The Red Lodge, 1 High Street"
            ],
            "addressType": "BUSINESS",
            "buildingNumber": "1",
            "country": "GB",
            "countrySubDivision": [
              "North Yorkshire"
            ],
            "department": "1",
            "postCode": "YO62 5JB",
            "streetName": "High Street",
            "subDepartment": "Flat 2",
            "townName": "York"
          }
        },
        "flowType": "FULL_HOSTED_PAGES",
        "externalPsuReference": "psu external reference 12345"
      },
      "refundDetails": {
        "refundAccount": {
          "iban": "GB29NWBK60161331926819",
          "bic": "BOFIIE2D",
          "name": "John Smith"
        },
        "paymentRefundStatus": "NONE",
        "settledRefundAmount": {
          "value": "10.23",
          "currency": "EUR"
        },
        "remainingRefundAmount": {
          "value": "10.23",
          "currency": "EUR"
        }
      },
      "status": "INITIATION_COMPLETED",
      "statusReasonInformation": "The payment is settled on the debtor side.",
      "bankPaymentStatus": "ACPC",
      "bankPaymentId": "1231423",
      "bankTransactionId": "2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV",
      "bankVrpStatus": "AcceptedCreditSettlementCompleted",
      "authentication": {
        "redirectUrl": "http://psu-redirect.com"
      },
      "createdDateTime": "2023-04-05T17:02:11.954Z",
      "updatedDateTime": "2023-04-05T17:02:11.954Z",
      "errorInfo": {
        "httpErrorCode": 503,
        "message": "UNAVAILABLE: HTTP connection failed",
        "tokenExternalError": true,
        "tokenTraceId": "eASI3Onqkpi1unAM59O5"
      },
      "paymentLinkStatus": "LINK_ACTIVE"
    }
  ],
  "pageInfo": {
    "limit": 20,
    "offset": "LerV6Jmex",
    "nextOffset": "KgwG8Qkat"
  }
}