---
title: "Get bulk payment"
method: GET
path: "/payment/v1/bulk-payments/{id}"
tags: ["Payment.Bulk Payment", "BETA"]
---

# Get bulk payment

`GET /payment/v1/bulk-payments/{id}`

Returns the bulk payment data of the given id.

## Path parameters

- `id` string, required

## Query parameters

- `view` 'BASIC' | 'FULL'

## Response `200`

A successful response.

- V1BulkPaymentResponse
  - `id` string — The id of the bulk payment.
  - `paymentRequests` V1PaymentRequest[] — List of single payment details.
    - `amount` number, float — The amount of the payment.
    - `created` string, int64 — The timestamp of creation of a payment request.
    - `currency` 'CURRENCY_UNSPECIFIED' | 'SEK' | 'GBP' | 'EUR' — - CURRENCY_UNSPECIFIED: Default value. It should not occur. - SEK: Swedish krona. - GBP: Pound sterling. - EUR: Euro.
    - `destinations` V1AccountIdentifier[] — A list of account numbers that can receive the payment. If one of the accounts belong to the same bank as the source account, it will be selected. Otherwise the first one from the list will be selected.
      - `accountNumber` string — The payee's account number.
      - `type` 'ACCOUNT_IDENTIFIER_TYPE_UNSPECIFIED' | 'SE' | 'SE_BG' | 'SE_PG' | 'IBAN' — - ACCOUNT_IDENTIFIER_TYPE_UNSPECIFIED: Default value. It should not occur. - SE: Account type used in SE. - SE_BG: BankGiro account type used in SE. - SE_PG: PlusGiro account type used in SE. - IBAN: IBAN account type.
    - `executionDate` string — The date defining when the payment will be executed by the bank. If no execution date is given, it will be executed as soon as possible. The date follows the ISO 8601 with format yyyy-MM-dd.
    - `id` string — Payment request id.
    - `market` string — The country code (in ISO 3166-1 alpha-2 format) of the primary market of the payer. Values: SE.
    - `merchantId` string — The id of the merchant tied to the payment.
    - `paymentScheme` 'PAYMENT_SCHEME_UNSPECIFIED' | 'SEPA_CREDIT_TRANSFER' | 'SEPA_INSTANT_CREDIT_TRANSFER' — - PAYMENT_SCHEME_UNSPECIFIED: Default value. It should not occur. - SEPA_CREDIT_TRANSFER: SEPA Credit Transfer scheme. - SEPA_INSTANT_CREDIT_TRANSFER: SEPA Instant Credit Transfer scheme.
    - `providerName` string — The provider (financial institution) that the payer's account belongs to.
    - `recipientName` string — The recipient name shown to the payer on signing payments. Maximum character count of 30.
    - `remittanceInformation` V1RemittanceInformation
      - `type` 'REMITTANCE_INFORMATION_TYPE_UNSPECIFIED' | 'UNSTRUCTURED' | 'OCR' | 'REFERENCE' — - REMITTANCE_INFORMATION_TYPE_UNSPECIFIED: Default value should not occur. - UNSTRUCTURED: Information supplied in an unstructured form. - OCR: The OCR number, used in SE. - REFERENCE: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
      - `value` string — The structured or unstructured remittance information value for the bulk payment.
    - `source` V1PaymentSource
      - `accountNumber` string — The source account number.
      - `type` string — The source account type.
      - `uri` string — The source account URI.
    - `sourceMessage` string — The transaction description that only appears on the payer (debtor) account for the payment. Use for providing a short description about the payment transaction for the payer. Maximum character count of 50 (Note that some banks might have a more strict limit).
    - `status` 'PAYMENT_STATUS_TYPE_UNSPECIFIED' | 'CREATED' | 'EXECUTING' | 'AWAITING_CREDENTIALS' | 'SENT' | 'CANCELLED' | 'FAILED' — - PAYMENT_STATUS_TYPE_UNSPECIFIED: Status unspecified. - CREATED: Payment created. - EXECUTING: Payment execution started. - AWAITING_CREDENTIALS: Payment is awaiting credentials. - SENT: Payment has been sent to the bank. - CANCELLED: Payment has been cancelled. - FAILED: Payment has failed.
    - `statusMessage` string — A message explaining the current status of the payment. This field is populated only if status is one of the terminal statuses.
    - `updated` string, int64 — The timestamp of update of a payment request.
  - `status` 'BULK_PAYMENT_STATUS_TYPE_UNSPECIFIED' | 'CREATED' | 'EXECUTING' | 'AWAITING_CREDENTIALS' | 'SENT' | 'CANCELLED' | 'FAILED' | 'PARTIALLY_SENT' | 'SETTLED_PAYER' | 'SETTLED_PAYEE' — - BULK_PAYMENT_STATUS_TYPE_UNSPECIFIED: Status unspecified. - CREATED: Bulk payment created. - EXECUTING: Bulk payment execution started. - AWAITING_CREDENTIALS: Bulk payment is awaiting credentials. - SENT: Bulk payment has been sent to the bank. - CANCELLED: Bulk payment has been cancelled. - FAILED: Bulk payment has failed. - PARTIALLY_SENT: At least one payment within a bulk has not been sent to the bank. - SETTLED_PAYER: All payments has settled payer status. - SETTLED_PAYEE: All payments has settled payee status.
  - `verificationStatus` object — Verification status for the bulk payment.

## Other responses

- `401` — The scopes associated with the access token is not allowed the resource.
- `403` — The resource does not belong to subject associated with the access token.
- `404` — Bulk Payment with given ID does not exist.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/tink/apis/tink-api.md) · [All operations](https://skmtc.net/tink/apis/tink-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tink/tink-api/revisions/23d8982b533d/schema)