Payment report

POST 
/v1/reports/payments_report

Returns payment report using the specified criteria

Request

application/json

Body

date_from daterequired

Requested payment date period start

date_to date

Requested payment date period end If not specified considered as the current date by default

instrument stringrequired

Instrument expressed as a currency pair.

Responses

200

Your request has been successfully processed

application/json

Schema

Schema

• Array [

GrpHdr

GrpHdr

required

MsgId stringrequired

Example: 1234567890123456

CreDtTm string

Example: 2024-07-04T12:34:56

NbOfTxs stringrequired

Example: 1

SttlmInf

SttlmInf

SttlmMtd stringrequired

Example: CLRG

InstgAgt

InstgAgt

FinInstnId

FinInstnId

BICFI stringrequired

Example: INSTBICXXXX

InstdAgt

InstdAgt

Nm string

BranchIdentification

BranchIdentification

Id stringrequired

FinInstnId

FinInstnId

required

BICFI stringrequired

Example: INSDBICXXXX

paymentProviderInfo

object

required

providerName string

providerTransactionId string

providerTransactionStatus string

providerTransactionStatusCode string
status stringrequired
Latest payment status change.
Possible values: [pending, accepted, rejected]
Default value: pending
errCode string

• ]

Example (from schema)

[
  {
    "GrpHdr": {
      "MsgId": "1234567890123456",
      "CreDtTm": "2024-07-04T12:34:56",
      "NbOfTxs": "1",
      "SttlmInf": {
        "SttlmMtd": "CLRG"
      },
      "InstgAgt": {
        "FinInstnId": {
          "BICFI": "INSTBICXXXX"
        }
      },
      "InstdAgt": {
        "Nm": "string",
        "BranchIdentification": {
          "Id": "string"
        },
        "FinInstnId": {
          "BICFI": "INSDBICXXXX"
        }
      }
    },
    "paymentProviderInfo": {
      "providerName": "string",
      "providerTransactionId": "string",
      "providerTransactionStatus": "string",
      "providerTransactionStatusCode": "string"
    },
    "status": "pending",
    "errCode": "string"
  }
]

401

Authentication token is required for this action that was not provided, expired or invalid.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

403

Not authorized for the requested action.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

409

Action could not be completed because of conflict.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

500

Internal server error.

application/json

Schema

Schema

errorId string

Links error message to a specific event in the system.

code stringrequired

The code for the error that has occurred.

text stringrequired

The text for the error that has occurred.

parameter_name string

An optional parameter name related to the error. Usually present for input validation errors.

parameter_value object

An optional parameter value related to the error. Set to input value of named parameter.

Example (from schema)

{
  "errorId": "string",
  "code": "string",
  "text": "string",
  "parameter_name": "string",
  "parameter_value": {}
}

Loading...