API-Referenz | Initiated payments

Methode	Pfad	Zusammenfassung
GET	…/initiated-payments	List initiated payments in the workspace
POST	…/initiated-payments	Create and send an initiated payment
GET	…/initiated-payments/{initiatedPaymentId}/initiated-transfers	List transfers belonging to an initiated payment

Die Pfade beginnen mit /workspaces/{workspaceId}. GET-Endpunkte brauchen initiated-payments:read, die übrigen initiated-payments:write.

Das Objekt InitiatedPayment

firestoreIdstringerforderlich

ID of the initiated payment.

transferIdsstring[]erforderlich

workspaceIdstringerforderlich

ID of the workspace.

bankAccountIdstringerforderlich

ID of the bank account.

writeConsentIdstring

ID of the write consent.

counterpartyIdsstring[]erforderlich

transferCounterpartyIdsRecord<string, string>erforderlich

Alle 13 Felder anzeigen

creationobjecterforderlich

When and by whom the resource was created.

2 untergeordnete Felder anzeigen

creationDateTimestringdate-timeerforderlich

Date and time when the resource was created.

createdBystring

ID of the user who created the resource, when recorded.

invoiceIdsstring[]

instructionobjecterforderlich

7 untergeordnete Felder anzeigen

executionDatestring

paymentMethodstring

paymentInformationIdstring

debtorNamestring

debtorIbanstring

debtorCurrencystring

debtorBicstring

submissionStatusobject

2 untergeordnete Felder anzeigen

statusstring

creationDateTimestring

instructionStatusobject

1 untergeordnetes Feld anzeigen

statusstring

relationshipsobjecterforderlich

1 untergeordnetes Feld anzeigen

firstTransfersInitiatedPaymentTransfer[]erforderlich

8 untergeordnete Felder anzeigen

firestoreIdstringerforderlich

ID of the initiated payment transfer.

workspaceIdstringerforderlich

ID of the workspace.

initiatedPaymentIdstringerforderlich

ID of the initiated payment.

bankAccountIdstringerforderlich

ID of the bank account.

counterpartyIdstringerforderlich

ID of the counterparty.

transferCreditTransfererforderlich

8 untergeordnete Felder anzeigen

instructionIdstring

endToEndIdstringerforderlich

amountnumber

currencystring

creditorNamestring

creditorIbanstring

communicationstring

structuredReferencestring

transferStatusobjecterforderlich

2 untergeordnete Felder anzeigen

statusstring

acceptanceDateTimestring

relationshipsobjecterforderlich

1 untergeordnetes Feld anzeigen

counterpartyCounterpartyerforderlich

Das Objekt InitiatedPayment

{
  "firestoreId": "ipay_SVAtMjAyNjAzMDI",
  "transferIds": [
    "string"
  ],
  "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
  "bankAccountId": "bacc_Q0gzMTA4NzY1NDM",
  "writeConsentId": "wcons_V1JJVEUtMDA0Mg",
  "counterpartyIds": [
    "string"
  ],
  "transferCounterpartyIds": {
    "key": "string"
  },
  "creation": {
    "creationDateTime": "2026-03-02T09:15:00.000Z",
    "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
  },
  "invoiceIds": [
    "string"
  ],
  "instruction": {
    "executionDate": "string",
    "paymentMethod": "string",
    "paymentInformationId": "string",
    "debtorName": "string",
    "debtorIban": "string",
    "debtorCurrency": "string",
    "debtorBic": "string"
  },
  "submissionStatus": {
    "status": "string",
    "creationDateTime": "string"
  },
  "instructionStatus": {
    "status": "string"
  },
  "relationships": {
    "firstTransfers": [
      {
        "firestoreId": "itrans_SVQtMjAyNjAzMDI",
        "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
        "initiatedPaymentId": "ipay_SVAtMjAyNjAzMDI",
        "bankAccountId": "bacc_Q0gzMTA4NzY1NDM",
        "counterpartyId": "Cp2nG7vB4xLq9wRt5hMz",
        "transfer": {
          "instructionId": "string",
          "endToEndId": "string",
          "amount": 0,
          "currency": "string",
          "creditorName": "string",
          "creditorIban": "string",
          "communication": "string",
          "structuredReference": "string"
        },
        "transferStatus": {
          "status": "string",
          "acceptanceDateTime": "string"
        },
        "relationships": {
          "counterparty": {
            "firestoreId": "Cp2nG7vB4xLq9wRt5hMz",
            "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
            "creation": {
              "creationDateTime": "2026-03-02T09:15:00.000Z",
              "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
            },
            "activation": {
              "enabled": true,
              "updateDateTime": "2026-03-02T09:15:00.000Z",
              "updatedBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
            },
            "entityType": "individual",
            "name": "string",
            "phones": [
              "string"
            ],
            "emails": [
              "string"
            ],
            "address": {
              "country": "CH",
              "postCode": "8001",
              "townName": "Zürich",
              "streetName": "Bahnhofstrasse",
              "buildingNumber": "10",
              "name": "Haus zur Linde",
              "sortingCode": "string",
              "postBox": "Postfach 1234",
              "administrativeArea": "Zürich",
              "recipients": [
                "Anna Meier"
              ],
              "organization": "Muster AG",
              "source": [
                "Muster AG",
                "Bahnhofstrasse 10",
                "8001 Zürich"
              ]
            },
            "contactPersons": [
              {
                "name": "string",
                "phone": "string",
                "email": "string"
              }
            ],
            "taxIdentification": "string",
            "notes": "string",
            "cashAccounts": [
              {
                "identifications": [
                  {
                    "type": "bic",
                    "value": "string"
                  }
                ],
                "currency": "CHF",
                "bankAddress": {
                  "country": "CH",
                  "postCode": "8001",
                  "townName": "Zürich",
                  "streetName": "Bahnhofstrasse",
                  "buildingNumber": "10",
                  "name": "Haus zur Linde",
                  "sortingCode": "string",
                  "postBox": "Postfach 1234",
                  "administrativeArea": "Zürich",
                  "recipients": [
                    "Anna Meier"
                  ],
                  "organization": "Muster AG",
                  "source": [
                    "Muster AG",
                    "Bahnhofstrasse 10",
                    "8001 Zürich"
                  ]
                },
                "internalId": "string",
                "nickname": "string",
                "verification": {
                  "id": "3f2c8a1e-6b4d-4e7a-9c15-8d2b7f0e4a61",
                  "status": "verified",
                  "holderName": "string",
                  "dateTime": "2026-03-02T09:30:00.000Z"
                }
              }
            ],
            "cashAccountIdentifications": [
              "string"
            ],
            "approvedCashAccountIds": [
              "string"
            ],
            "bankAccountId": "string"
          }
        }
      }
    ]
  }
}

GET/workspaces/{workspaceId}/initiated-payments

List initiated payments in the workspace

Bereichinitiated-payments:read

Pfadparameter

workspaceIdstringerforderlich

ID of the workspace.

Abfrageparameter

limitinteger

Maximum number of items to return, from 1 to 100. A missing, invalid or non-positive value falls back to 20, and a larger value to 100.

Standard20

startAfterstring

Cursor of the page to return: the nextCursor of the previous page.

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

idsstring[]

Comma-separated IDs of the items to return, up to 30. When set, limit, startAfter and the filters are ignored.

Rückgabe

200

List of items

dataInitiatedPayment[]erforderlich

Items of the page, in list order.

limitintegererforderlich

Page size of the request, or the number of requested ids.

nextCursorstring

Cursor of the next page, to pass as startAfter. Absent when the page holds fewer items than limit; a full last page still has one, and the page it points to is empty.

curl 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/initiated-payments' \
  -H "Authorization: Bearer $SWAY_API_KEY"

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/initiated-payments', {
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
  },
});
console.log(await response.json());

import os

import requests

response = requests.get(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/initiated-payments",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
)
print(response.json())

{
  "data": [
    {
      "firestoreId": "ipay_SVAtMjAyNjAzMDI",
      "transferIds": [
        "string"
      ],
      "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
      "bankAccountId": "bacc_Q0gzMTA4NzY1NDM",
      "writeConsentId": "wcons_V1JJVEUtMDA0Mg",
      "counterpartyIds": [
        "string"
      ],
      "transferCounterpartyIds": {
        "key": "string"
      },
      "creation": {
        "creationDateTime": "2026-03-02T09:15:00.000Z",
        "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
      },
      "invoiceIds": [
        "string"
      ],
      "instruction": {
        "executionDate": "string",
        "paymentMethod": "string",
        "paymentInformationId": "string",
        "debtorName": "string",
        "debtorIban": "string",
        "debtorCurrency": "string",
        "debtorBic": "string"
      },
      "submissionStatus": {
        "status": "string",
        "creationDateTime": "string"
      },
      "instructionStatus": {
        "status": "string"
      },
      "relationships": {…}
    }
  ],
  "limit": 0,
  "nextCursor": "string"
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

POST/workspaces/{workspaceId}/initiated-payments

Create and send an initiated payment

Bereichinitiated-payments:write

Pfadparameter

workspaceIdstringerforderlich

ID of the workspace.

Abfrageparameter

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

Request-Body

consentIdstringerforderlich

Rückgabe

200

Successful response

dataInitiatedPaymenterforderlich

curl -X POST 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/initiated-payments' \
  -H "Authorization: Bearer $SWAY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "consentId": "3f2c8a1e-6b4d-4e7a-9c15-8d2b7f0e4a61"
}'

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/initiated-payments', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "consentId": "3f2c8a1e-6b4d-4e7a-9c15-8d2b7f0e4a61"
  }),
});
console.log(await response.json());

import os

import requests

response = requests.post(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/initiated-payments",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
    json={
        "consentId": "3f2c8a1e-6b4d-4e7a-9c15-8d2b7f0e4a61",
    },
)
print(response.json())

{
  "data": {
    "firestoreId": "ipay_SVAtMjAyNjAzMDI",
    "transferIds": [
      "string"
    ],
    "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
    "bankAccountId": "bacc_Q0gzMTA4NzY1NDM",
    "writeConsentId": "wcons_V1JJVEUtMDA0Mg",
    "counterpartyIds": [
      "string"
    ],
    "transferCounterpartyIds": {
      "key": "string"
    },
    "creation": {
      "creationDateTime": "2026-03-02T09:15:00.000Z",
      "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
    },
    "invoiceIds": [
      "string"
    ],
    "instruction": {
      "executionDate": "string",
      "paymentMethod": "string",
      "paymentInformationId": "string",
      "debtorName": "string",
      "debtorIban": "string",
      "debtorCurrency": "string",
      "debtorBic": "string"
    },
    "submissionStatus": {
      "status": "string",
      "creationDateTime": "string"
    },
    "instructionStatus": {
      "status": "string"
    },
    "relationships": {…}
  }
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

GET/workspaces/{workspaceId}/initiated-payments/{initiatedPaymentId}/initiated-transfers

List transfers belonging to an initiated payment

Bereichinitiated-payments:read

Pfadparameter

workspaceIdstringerforderlich

ID of the workspace.

initiatedPaymentIdstringerforderlich

ID of the initiated payment.

Abfrageparameter

limitinteger

Maximum number of items to return, from 1 to 100. A missing, invalid or non-positive value falls back to 20, and a larger value to 100.

Standard20

startAfterstring

Cursor of the page to return: the nextCursor of the previous page.

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

idsstring[]

Comma-separated IDs of the items to return, up to 30. When set, limit, startAfter and the filters are ignored.

Rückgabe

200

List of items

dataInitiatedPaymentTransfer[]erforderlich

Items of the page, in list order.

8 untergeordnete Felder anzeigen

firestoreIdstringerforderlich

ID of the initiated payment transfer.

workspaceIdstringerforderlich

ID of the workspace.

initiatedPaymentIdstringerforderlich

ID of the initiated payment.

bankAccountIdstringerforderlich

ID of the bank account.

counterpartyIdstringerforderlich

ID of the counterparty.

transferCreditTransfererforderlich

8 untergeordnete Felder anzeigen

instructionIdstring

endToEndIdstringerforderlich

amountnumber

currencystring

creditorNamestring

creditorIbanstring

communicationstring

structuredReferencestring

transferStatusobjecterforderlich

2 untergeordnete Felder anzeigen

statusstring

acceptanceDateTimestring

relationshipsobjecterforderlich

1 untergeordnetes Feld anzeigen

counterpartyCounterpartyerforderlich

limitintegererforderlich

Page size of the request, or the number of requested ids.

nextCursorstring

Cursor of the next page, to pass as startAfter. Absent when the page holds fewer items than limit; a full last page still has one, and the page it points to is empty.

curl 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/initiated-payments/ipay_SVAtMjAyNjAzMDI/initiated-transfers' \
  -H "Authorization: Bearer $SWAY_API_KEY"

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/initiated-payments/ipay_SVAtMjAyNjAzMDI/initiated-transfers', {
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
  },
});
console.log(await response.json());

import os

import requests

response = requests.get(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/initiated-payments/ipay_SVAtMjAyNjAzMDI/initiated-transfers",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
)
print(response.json())

{
  "data": [
    {
      "firestoreId": "itrans_SVQtMjAyNjAzMDI",
      "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
      "initiatedPaymentId": "ipay_SVAtMjAyNjAzMDI",
      "bankAccountId": "bacc_Q0gzMTA4NzY1NDM",
      "counterpartyId": "Cp2nG7vB4xLq9wRt5hMz",
      "transfer": {
        "instructionId": "string",
        "endToEndId": "string",
        "amount": 0,
        "currency": "string",
        "creditorName": "string",
        "creditorIban": "string",
        "communication": "string",
        "structuredReference": "string"
      },
      "transferStatus": {
        "status": "string",
        "acceptanceDateTime": "string"
      },
      "relationships": {
        "counterparty": {
          "firestoreId": "Cp2nG7vB4xLq9wRt5hMz",
          "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
          "creation": {
            "creationDateTime": "2026-03-02T09:15:00.000Z",
            "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
          },
          "activation": {
            "enabled": true,
            "updateDateTime": "2026-03-02T09:15:00.000Z",
            "updatedBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
          },
          "entityType": "individual",
          "name": "string",
          "phones": [
            "string"
          ],
          "emails": [
            "string"
          ],
          "address": {
            "country": "CH",
            "postCode": "8001",
            "townName": "Zürich",
            "streetName": "Bahnhofstrasse",
            "buildingNumber": "10",
            "name": "Haus zur Linde",
            "sortingCode": "string",
            "postBox": "Postfach 1234",
            "administrativeArea": "Zürich",
            "recipients": [
              "Anna Meier"
            ],
            "organization": "Muster AG",
            "source": [
              "Muster AG",
              "Bahnhofstrasse 10",
              "8001 Zürich"
            ]
          },
          "contactPersons": [
            {
              "name": "string",
              "phone": "string",
              "email": "string"
            }
          ],
          "taxIdentification": "string",
          "notes": "string",
          "cashAccounts": [
            {
              "identifications": [
                {
                  "type": "bic",
                  "value": "string"
                }
              ],
              "currency": "CHF",
              "bankAddress": {
                "country": "CH",
                "postCode": "8001",
                "townName": "Zürich",
                "streetName": "Bahnhofstrasse",
                "buildingNumber": "10",
                "name": "Haus zur Linde",
                "sortingCode": "string",
                "postBox": "Postfach 1234",
                "administrativeArea": "Zürich",
                "recipients": [
                  "Anna Meier"
                ],
                "organization": "Muster AG",
                "source": [
                  "Muster AG",
                  "Bahnhofstrasse 10",
                  "8001 Zürich"
                ]
              },
              "internalId": "string",
              "nickname": "string",
              "verification": {
                "id": "3f2c8a1e-6b4d-4e7a-9c15-8d2b7f0e4a61",
                "status": "verified",
                "holderName": "string",
                "dateTime": "2026-03-02T09:30:00.000Z"
              }
            }
          ],
          "cashAccountIdentifications": [
            "string"
          ],
          "approvedCashAccountIds": [
            "string"
          ],
          "bankAccountId": "string"
        }
      }
    }
  ],
  "limit": 0,
  "nextCursor": "string"
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

Cookies, mit Ihrer Einwilligung

Initiated payments

Das Objekt InitiatedPayment

List initiated payments in the workspace

Pfadparameter

Abfrageparameter

Rückgabe

Create and send an initiated payment

Pfadparameter

Abfrageparameter

Request-Body

Rückgabe

List transfers belonging to an initiated payment

Pfadparameter

Abfrageparameter

Rückgabe

Bauen Sie auf Ihren eigenen Daten.