GET/vopgateway/v1/bulk/{taskId}

Bulk Results Request API Specification

This chapter provides detailed information on how to retrieve the results of a bulk request. The results file can only be accessed after the status of the bulk request has been updated to PROCESSED. The response to this request is returned in NDJSON format, containing the finalized data for the completed bulk operation. You can read about the error status and codes here.

Document History

VersionDateDescription
1.015 Jan 2025Original Digital Version. Aligned with PDF V1.0
1.120 Feb 2025Updated Language in requeste header from ISO639 to ISO639-1
2.020 Mar 2025Format changes, aligned with VoP single check API. Refer to the detailed changes here.
2.116 Apr 2025Updated 'fraudRiskIndicator' type from 'Object' to 'Array of Objects' and added the following new headers: X-End-User, X-Software-Supplier and X-Channel

Go directly to

Request

Request Headers

  • Name
    X-Request-Id
    Type
    String
    Tag(s)
    Mandatory
    Description

    A RFC4122 UUID used as a correlation id.

  • Name
    Content-Type
    Type
    String
    Tag(s)
    Mandatory
    Description

    Content type and encoding of the request.

    • Example: application/json
  • Name
    Authorization
    Type
    String
    Tag(s)
    Mandatory
    Description

    OAuth 2.0 bearer token.

  • Name
    Accept
    Type
    String
    Tag(s)
    Mandatory
    Description

    The media type the client can process in the response. This is set to application/x-ndjson.

    • Example: applicaton/x-ndjson
  • Name
    Accept-Language
    Type
    String
    Tag(s)
    Optional
    Description

    Can be provided by the Requesting PSP to be used as language in the 'nameSuggestion' response field (when data is available in the given language).

    • Format: ISO 639-1.
  • Name
    X-End-User
    Type
    string
    Tag(s)
    Optional
    Description

    This field is used to identify the endpoint user, customer, department or system.

    • In case the customer identifies more departments/end users within the same company which will use the API. Every department could be identified with a unique X-End-User.
    • In case the customer is reselling the API as a partner. Every new customer of the partner should be identified with a unique X-End-User.
    • Value of the header will have no effect on the end result.
    • Format: Max. 50 characters
    • Format: ^[a-zA-Z0-9\-]{3,50}
  • Name
    X-Software-Supplier
    Type
    string
    Tag(s)
    Optional
    Description

    It is used in case there is an external software supplier involved. This header must be provided if you are using a third party software supplier. In case the SurePay customer uses more than one software supplier then all of them can be provided in the header.

    • Format: Max. 70 characters
    • Example: X-Software-Supplier = "supplierA" / "supplierB" / "supplierC"
  • Name
    X-Channel
    Type
    string
    Tag(s)
    Optional
    Description

    In case the customer wants to distinguish traffic based on their channel. A channel can be set by the customer at any value and the value will show up in reporting.

    • Format: Max. 70 characters
    • Example: X-Channel = "web" / "mobile"

Example of Request headers

Header nameExample
X-Request-Id123e4567-e89b-12d3-a456-42661417400
Content-Typeapplication/json;charset=utf-8
AuthorizationBearer <your bearer token>
Acceptapplication/x-ndjson
Accept-LanguageEN
X-End-UserFinanceDepartment
X-Software-SupplierSupplierA
X-ChannelWeb

Request Body

This endpoint does not require a request body. The taskId is passed as a path parameter.

  • Name
    taskId
    Type
    String
    Tag(s)
    Mandatory
    Description

    The Unique ID used for retrieving the result in a separate request. This is returned in the response when submitting the bulk request.

Request

GET
/vopgateway/v1/bulk/taskId
GET /vopgateway/v1/bulk/12930484-129284501-ecernb

Response

The response is an NDJSON file.

  • Successful response (HTTP 200 - described below)
  • Error response (HTTPXXX - described in Errors)

Response Headers

  • Name
    X-Request-Id
    Type
    String
    Tag(s)
    Mandatory
    Description

    Value as sent in the corresponding request header.

  • Name
    Content-Type
    Type
    String
    Tag(s)
    Mandatory
    Description

    Content type and encoding of the request.

    • Example: application/json
  • Name
    Content-Disposition
    Type
    String
    Tag(s)
    Mandatory
    Description

    Attachment where the filename is the taskId.

    • Example: "taskId.ndjson"

Example of Response headers

Header nameExample
X-Request-Id123e4567-e89b-12d3-a456-42661417400
Content-Typeapplication/json;charset=utf-8
Content-DispositiontaskId.ndjson

Response Body

  • Name
    uetr
    Type
    String
    Tag(s)
    Mandatory
    Description

    The Unique End-to-End Transaction Reference (UETR) is an RFC4122 UUID used as a record-level correlation ID to uniquely track and trace individual transactions throughout the process.

  • Name
    partyNameMatch
    Type
    Enum
    Tag(s)
    Conditional
    Description

    Describes the result of the IBAN-Name Check.

    • MTCH (Match): The name matches exactly with a record in the system – a confirmed match.
    • CMTC (Close Match): The name closely matches a record but may have slight differences, like spelling variations – a partial or approximate match.
    • NMTC (No Match): The name doesn’t match any records in the system – no match found.
    • NOAP (Not Applicable): Verification check not possible, validation check is not applicable.

    Only applicable when name field has been added in the request.

  • Name
    partyIdMatch
    Type
    Enum
    Tag(s)
    Conditional
    Description

    Describes the result of the IBAN-ID Check.

    • MTCH (Match): The ID matches a record in the system - a confirmed match.
    • NMTC (No Match): The ID does not match any records - no match found.
    • NOAP (Not Applicable): The ID code is not supported or known by the Responding PSP - Verification check not possible, validation check is not applicable.

    Only applicable if identification object has been added in the request.

  • Name
    matchedName
    Type
    String
    Tag(s)
    Conditional
    Description

    Returns the corrected name of the account holder. Always returned in case of a Close Match (CMTC). It’s also returned in case of a No Match (NMTC) and the account type is ‘ORG', if supported by the Responding PSP.

  • Name
    additionalPartyInformation
    Type
    Object
    Tag(s)
    Conditional
    Description

Response

{"uetr": "2f01983c-a558-445c-8728-dba547d2ff8b", "partyNameMatch": "MTCH"}
Previous
Next