Accept a PACS 008 payment instructions

POST 
/v1/payment_instructions

Add PACS 008 payment instructions to the trade.

Request

application/json

Body

required

Document

Document

xmlns string

Example: urn:iso:std:iso:20022:tech:xsd:pacs.008.001.02

FIToFICstmrCdtTrf

FIToFICstmrCdtTrf

required

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

CdtTrfTxInf

CdtTrfTxInf

required

PmtId

PmtId

required

EndToEndId stringrequired

Example: Invoice 123456

IntrBkSttlmAmt

object

required

Ccy stringrequired

Example: EUR

value doublerequired

Example: 1000.00

IntrBkSttlmDt date

ChrgBr string

Example: SLEV

Dbtr

Dbtr

required

Nm stringrequired

Example: Debtor Name

PstlAdr

object

required

Ctry stringrequired

Example: DE

TwnNm stringrequired

Example: Berlin

PstlCd string

Example: SW12N2

AdrLine string[]required

Example: [ "Address Line 1", "Address Line 2" ]

Id

Id

OrgId

OrgId

Othr

Othr

Id string

Example: DE987654321

DbtrAcct

DbtrAcct

required

Id

Id

required

IBAN stringrequired

Example: DE89370400440532013000

Othr

Othr

Id string

Example: FR123456789

DbtrAgt

DbtrAgt

FinInstnId

FinInstnId

BICFI stringrequired

Example: DEUTDEFFXXX

UltmtDbtr

object

Nm string

Example: Ultimate Debtor Name

PstlAdr

object

Ctry stringrequired

Example: DE

TwnNm stringrequired

Example: Berlin

PstlCd string

Example: SW12N2

AdrLine string[]required

Example: [ "Address Line 1", "Address Line 2" ]

Id

object

OrgId

OrgId

Othr

Othr

Id string

SchmeNm

SchmeNm

Prtry string

Issr string

PrvtId

PrvtId

DtAndPlcOfBirth

BirthDt date

CtryOfBirth string

CityOfBirth string

PrvcOfBirth string

Othr

Othr

Id string

SchmeNm

SchmeNm

Prtry string

Issr string

CtryOfRes string

CtctDtls

object

NmPrfx string

Nm string

PhneNb string

MobNb string

FaxNb string

URLAdr string

EmailAdr string

JobTitl string

Rspnsblty string

Dept string

Othr

Othr

ChanlTp string

Id string

PrefrdMtd string

Possible values: [MAIL, FAXX, LETT, CELL, ONLI, PHON]

Cdtr

Cdtr

required

Nm stringrequired

Example: Creditor Name

PstlAdr

object

required

Ctry stringrequired

Example: DE

TwnNm stringrequired

Example: Berlin

PstlCd string

Example: SW12N2

AdrLine string[]required

Example: [ "Address Line 1", "Address Line 2" ]

Id

object

OrgId

OrgId

Othr

Othr

Id string

SchmeNm

SchmeNm

Prtry string

Issr string

PrvtId

PrvtId

DtAndPlcOfBirth

BirthDt date

CtryOfBirth string

CityOfBirth string

PrvcOfBirth string

Othr

Othr

Id string

SchmeNm

SchmeNm

Prtry string

Issr string

CtryOfRes string

CtryOfRes string

CtctDtls

object

NmPrfx string

Nm string

PhneNb string

MobNb string

FaxNb string

URLAdr string

EmailAdr string

JobTitl string

Rspnsblty string

Dept string

Othr

Othr

ChanlTp string

Id string

PrefrdMtd string

Possible values: [MAIL, FAXX, LETT, CELL, ONLI, PHON]

CdtrAcct

CdtrAcct

Id

Id

IBAN stringrequired

Example: FR7630006000011234567890189

Othr

Othr

Id string

Example: FR123456789

CdtrAgt

CdtrAgt

FinInstnId

FinInstnId

BICFI stringrequired

Example: BNPAFRPPXXX

CdtrAgtAcct

CdtrAgtAcct

Id

Id

Othr

Othr

Id string

Example: FR123456789

IntrmyAgt1

IntrmyAgt1

FinInstnId

IntrmyAgt1

BICFI string

Example: BNPAFRPPXXX

Purp

Purp

required

Cd stringrequired

Example: GDDS

RmtInf

RmtInf

required

Ustrd stringrequired

Example: AB12-XP34-5670

SplmtryData

SplmtryData

Envlp

Envlp

Any

Any

SourceOfFunds string

Example: Additional information here

SubPurpose string

Example: Additional information here

InvoiceNumber string

Example: Additional information here

Responses

200

Your request has been successfully processed and the payment instructions added to the trade.

application/json

Schema

Schema

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"
}

400

One or more parameter values are invalid. Please check and retry.

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": {}
}

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": {}
}

404

The requested endpoint or entity does not exist.

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": {}
}

503

The server is currently unavailable due to non-working hours. Please try again later.

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