--- title: "Get payments under a VRP consent" method: GET path: "/vrp-consents/{id}/payments" tags: ["Variable Recurring Payments"] --- # Get payments under a VRP consent `GET /vrp-consents/{id}/payments` The `GET /vrp-consents/{id}/payments` endpoint retrieves the payments under a given VRP consent. ## Path parameters - `id` string, required ## Query parameters - `limit` integer, required - `offset` string ## Response `200` Successful response - VrpsResponse - `vrps` Vrp[], required - `id` string, required — The Token.io generated VRP id. - `memberId` string, required — The Token.io-assigned member id of the TPP. - `initiation` VrpInitiation, required — The VRP initiation object. - `consentId` string, required — The id of the VRP consent. - `refId` string, required — The TPP-generated reference identifier for the token. This is not to be confused with the `requestId`. The `refId` maps to the `tppRefId` in the bank's `consentRequest`. This is needed to match/verify the originating token request with the bank's consent request.
We recommend that the `refId` should not contain special characters (the allowed characters are the 26-letter Latin alphabet, the numerical digits from 0-9 and the hyphen '-'). This field should not exceed 18 characters in length. - `remittanceInformationPrimary` string, required — The primary field for remittance information. This should contain a reference, as assigned by the creditor, to unambiguously refer to the payment transactions under this consent. The value of this field should appear on the bank statement and reconciliation file, irrespective of the payment network being used.
We recommend that the `remittanceInformationPrimary` field should not contain special characters (the allowed characters are the 26-letter Latin alphabet, the numerical digits from 0-9 and the hyphen '-') as banks may remove these when sending this field to the beneficiary. This field should not exceed 35 characters in length (18 characters for UK Faster Payments). - `remittanceInformationSecondary` string — The secondary field for remittance information. The information supplied should enable the reconciliation of an entry in an unstructured form. Depending on the payment network, information from this field may or may not be included in the bank statement and reconciliation file.
We recommend that the `remittanceInformationSecondary` field should not contain special characters (the allowed characters are the 26-letter Latin alphabet, the numerical digits from 0-9 and the hyphen '-') as banks may remove these when sending this field to the beneficiary. This field should not exceed 140 characters in length. - `amount` Amount, required — The transaction amount and currency. - `value` string, required — The transaction amount with up to four digits after the decimal point. - `currency` string, required — The ISO 4217 three letter currency code. - `confirmFunds` boolean — A flag indicating whether the bank should do a funds confirmation check before accepting the payment. If set to `true`, the funds will be checked. - `risk` Risk — This field is used to specify additional details for the risk scoring of payments. - `psuId` string — The merchant's unique customer identifier for the user. - `paymentContextCode` 'INVALID_PAYMENT_CONTEXT_CODE' | 'BILLING_GOODS_AND_SERVICES_IN_ADVANCE' | 'BILLING_GOODS_AND_SERVICES_IN_ARREARS' | 'PISP_PAYEE' | 'ECOMMERCE_MERCHANT_INITIATED_PAYMENT' | 'FACE_TO_FACE_POINT_OF_SALE' | 'TRANSFER_TO_SELF' | 'TRANSFER_TO_THIRD_PARTY' — This field describes the context of the payment context. This field is an OBIE standard and also maps to NextGenPsd2's `purposeCode` and `categoryPurposeCode` fields. We recommend that the TPP populates this field. - `paymentPurposeCode` 'CASH' | 'CORT' | 'DVPM' | 'INTC' | 'TREA' | 'SUPP' — The category code conforming to the Recommended UK Purpose Code in the ISO 20022 Payment Messaging List, related to the type of services or goods corresponding to the underlying purpose of the payment. This list applies to all banks that follow ISO 20022. - `merchantCategoryCode` string — The category code conforming to ISO 18245, relating to the type of services or goods provided by the merchant. A list of codes can be purchased here." - `beneficiaryAccountType` 'PERSONAL' | 'JOINT_PERSONAL' | 'PERSONAL_SAVINGS_ACCOUNT' | 'BUSINESS' | 'BUSINESS_SAVINGS_ACCOUNT' | 'CHARITY' | 'COLLECTION' | 'CORPORATE' | 'GOVERNMENT' | 'EWALLET' | 'INVESTMENT' | 'ISA' | 'PREMIER' | 'WEALTH' | 'PENSION' — This information should be provided if the `AccountType` is known. - `contractPresentIndicator` boolean — This field indicates whether a Payee has a contractual relationship with the Payment Initiation Service Provider (PISP). - `beneficiaryPrepopulatedIndicator` boolean — This field indicates whether the Payment Initiation Service Provider (PISP) has immutably prepopulated payment details for the user. - `deliveryAddress` DeliveryAddress — Specifies the recipient's delivery address details. - `addressLine` string[] — Specifies the delivery address using multiple lines, as necessary. - `addressType` 'INVALID_ADDRESS_TYPE' | 'BUSINESS' | 'CORRESPONDENCE' | 'DELIVERYTO' | 'MAILTO' | 'POBOX' | 'POSTAL' | 'RESIDENTIAL' | 'STATEMENT' — Specifies the type of address. - `buildingNumber` string — The building number within the delivery address. - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2). - `countrySubDivision` string[] — Identifies a subdivision of a country; for instance, a state, region, or county. - `department` string — This OBIE specification maps to house number. - `postCode` string — An identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `streetName` string — The name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received. - `subDepartment` string — This OBIE specification maps to flats. - `townName` string — The name of a built-up area with defined boundaries and a local government. - `createdDateTime` string, required — The time when this VRP object was created (in ISO 8601 format). - `updatedDateTime` string, required — The date and time this VRP object was last updated (in ISO 8601 format). - `status` 'INITIATION_PENDING' | 'INITIATION_PROCESSING' | 'INITIATION_COMPLETED' | 'INITIATION_REJECTED' | 'INITIATION_REJECTED_INSUFFICIENT_FUNDS' | 'INITIATION_FAILED' | 'INITIATION_NO_FINAL_STATUS_AVAILABLE', required — The Token.io VRP status. - `bankVrpId` string — The VRP id from the bank. This field can be empty if the VRP id isn't available on the bank's side. - `bankVrpStatus` string — The raw bank status. This field can be empty if payment status isn't available on the bank's side. - `statusReasonInformation` string — A human-readable description of the reason for the reported status, which may include a message from the bank. This value should not exceed 256 characters in length. - `refundDetails` RefundDetails — The refund-related information for this payment. This field requires specific permission and is only available if `paymentInitiation.returnRefundAccount` is set to `true`. - `refundAccount` union, required - object — SEPA Instant account details where the iban is required and the bic is optional. - `iban` string, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs can be either 8 or 11 characters long. - `name` string — The name of the account owner. - object — SEPA account details where the iban is required and the bic is optional. - `iban` string, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs can be either 8 or 11 characters long. - `name` string — The name of the account owner. - object — A UK or Irish account where the sort code and account number are required. - `accountNumber` string, required — The unique identifier for the bank account in the UK or Ireland. - `sortCode` string, required — The number assigned to a branch of a bank, typically containing six digits and most commonly used in the UK and Ireland. - `name` string — The name of the account owner. - `paymentRefundStatus` 'NONE' | 'PARTIAL' | 'FULL' — The refund status for this payment. - `settledRefundAmount` object — The transaction amount and currency. - `value` string, required — The transaction amount with up to four digits after the decimal point. - `currency` string, required — The ISO 4217 three letter currency code. - `remainingRefundAmount` object — The transaction amount and currency. - `value` string, required — The transaction amount with up to four digits after the decimal point. - `currency` string, required — The ISO 4217 three letter currency code. - `pageInfo` PageInfo, required — The information about the current page, which also indicates whether the next page exists. - `limit` integer, required — The limit (maximum number of objects to return) applied to this page.
The default and maximum allowed limit is 200. If this limit is exceeded, was not set or was set to 0, it will be set to 200. - `offset` string — The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset is provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to the dynamic nature of the data.
The offset is opaque to a user and should not be parsed and/or understood in any way. - `nextOffset` string — The offset for the next page. If the page is empty, it is equal to this page offset. If the page is not empty, but there are no more objects to load (haveMore = false), it will be empty.
The offset is opaque to a user and should not be parsed and/or understood in any way. - `haveMore` boolean — This field indicates whether there are more objects to load, i.e. whether the next page exists. ## Other responses - `400` — Bad request - `401` — The authorization information is missing or invalid - `500` — An unexpected or internal server error --- [API](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps.md) · [All operations](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/token/token-io-s-open-banking-api-for-tpps/versions/5e8d6d2c24a1/schema)