Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Payment.Bulk Payment
BETA

Get bulk payment

Returns the bulk payment data of the given id.

get/payment/v1/bulk-payments/{id}

Path parameters

idstring required

The id of the requested bulk payment.

Query parameters

view'BASIC' | 'FULL'

Detail level of the response.

  • BASIC: Shows only the list of single payment ids.
  • FULL: Shows all the single payment details and statuses.

Response

A successful response.

idstring

The id of the bulk payment.

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.
verificationStatusobject

Verification status for the bulk payment.

Example response

{
  "id": "dc0cf17bf6fe43de9897a644a48e6005",
  "paymentRequests": [
    {
      "amount": 10,
      "created": "1674158472000",
      "currency": "SEK",
      "destinations": [
        {
          "accountNumber": "33008808080808",
          "type": "SE_PG"
        }
      ],
      "executionDate": "2022-05-22",
      "id": "18408f41163f4748b87da9b9a68b6df8",
      "market": "SE",
      "merchantId": "17697670-aed1-40d7-9084-daee87539f3d",
      "paymentScheme": "PAYMENT_SCHEME_UNSPECIFIED",
      "providerName": "handelsbanken-bankid",
      "recipientName": "Test AB",
      "remittanceInformation": {
        "type": "OCR",
        "value": "3245928392092"
      },
      "source": {
        "accountNumber": "SE4550000000058398257466",
        "type": "IBAN",
        "uri": "iban://SE4550000000058398257466"
      },
      "sourceMessage": "Gym Equipment",
      "status": "SENT",
      "statusMessage": "Payment successfully initiated",
      "updated": "1674220425783"
    },
    {
      "amount": 5.99,
      "created": "1674158472000",
      "currency": "SEK",
      "destinations": [
        {
          "accountNumber": "32438808083311",
          "type": "SE_PG"
        }
      ],
      "executionDate": "2022-05-20",
      "id": "ecad584cd7444494a88bfdc2eda875c6",
      "market": "SE",
      "merchantId": "17697670-aed1-40d7-9084-daee87539f3d",
      "paymentScheme": "PAYMENT_SCHEME_UNSPECIFIED",
      "providerName": "handelsbanken-bankid",
      "recipientName": "Test AB",
      "remittanceInformation": {
        "type": "OCR",
        "value": "5654928391123"
      },
      "source": {
        "accountNumber": "SE4550000000058398257466",
        "type": "IBAN",
        "uri": "iban://SE4550000000058398257466"
      },
      "sourceMessage": "Payment for Electricity",
      "status": "SENT",
      "statusMessage": "Payment successfully initiated",
      "updated": "1674220479791"
    }
  ],
  "status": "SENT"
}