- 17 Sep 2024
- 16 Minutes to read
- Print
- DarkLight
Camt.056.001.08
- Updated on 17 Sep 2024
- 16 Minutes to read
- Print
- DarkLight
This page shows a camt.056.001.08 compliant with SEPA Rulebook 2023.
Camt.056.001.08
The request must include a JSON payload object in the request body. The JSON payload is a camt.056.001.08 ISO message with the fitoFIPmtCxlReq root element, and it contains the request details for submitting a payment.
The functional changes for SEPA Rulebook 2023 are highlighted.
Table: camt.056.001.08.
Message field | Description | Data type | Required/Optional |
---|---|---|---|
assgnmt.id | Assignment ID, which must uniquely identify each request you send. This ID is used internally for idempotency of the API. | String | Required |
assgnmt.assgnr.agt.finInstnId.bicfi | Assigner's BICFI. | String | Required |
assgnmt.assgne.agt.finInstnId.bicfi | Assignee's BICFI. | String | Required |
assgnmt.creDtTm | Date and time of the payment request | String | Required |
ctrlData.nbOfTxs | Number of transactions within the message. Value: 1 | Number | Required. |
undrlyg.txInf.cxlId | Cancellation ID, which must uniquely identify each request you send. This ID is used internally for idempotency of the API. | String | Required |
undrlyg.txInf.orgnlGrpInf.orgnlMsgId | Original Message Identification. | String | Required |
undrlyg.txInf.orgnlGrpInf.orgnlMsgNmId | Original Message Name Identification. | String | Required |
undrlyg.txInf.orgnlInstrId | Original Instruction Identification. | String | Optional |
undrlyg.txInf.orgnlEndToEndId | Original End To End Identification. | String | Required |
undrlyg.txInf.orgnlTxId | Original Transaction Identification. | String | Required |
undrlyg.txInf.orgnlIntrBkSttlmAmt | Data structure containing the amount of money moved between the instructing agent and the instructed agent, as provided in the original instruction. The currency must be EUR and the amount must be a positive value. | Object | Required |
undrlyg.txInf.orgnlIntrBkSttlmDt | Original interbank settlement date. | String | Required |
undrlyg.txInf.cxlRsnInf.orgtr.nm | Name of the party that issues the cancellation request. | String | Required |
undrlyg.txInf.cxlRsnInf.orgtr.id.orgId.anyBIC | BICFI of the party that issues the cancellation request. | String | Required |
undrlyg.txInf.cxlRsnInf.rsn | Return reason. Can be cd or prtry ► .cd If used for a Request for Recall by the Originator the "Reason Code" can only be populated with ISO code "CUST" (Requested By Customer). If used for a Request for Recall by the Originator the "Reason Proprietary" can only be populated with the proprietary codes "AM09" (Wrong amount) and "AC03" (Wrong IBAN) ► .prtry | Object | Required |
undrlyg.txInf.cxlRsnInf.addtlInf | Aditional Info Only allowed when "CUST" is is used as a Recall reason code; or "FRAD", "AM09" or "AC03" are used as a Recall reason Proprietary. Only one occurrence is allowed. To be populated as follows:
| String | Optional |
undrlyg.txInf.orgnlTxRef.sttlmInf.sttlmMtd | Settlement method. | String | Required |
undrlyg.txInf.orgnlTxRef.sttlmInf.clrSys.prtry | Clearing System. | String | Required |
undrlyg.txInf.orgnlTxRef.pmtTpInf.svcLvl.prtry | Payment scheme type. Value: SEPA | String | Required |
undrlyg.txInf.orgnlTxRef.pmtTpInf.lclInstrm | Local Instrument. Can be cd or prtry. | String | Optional |
undrlyg.txInf.orgnlTxRef.pmtTpInf.ctgyPurp | Category Purpose. Can be cd or prtry. | String | Optional |
undrlyg.txInf.orgnlTxRef.rmtInf | Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system. Can be strd or ustrd. | Object | Optional |
undrlyg.txInf.orgnlTxRef.ultmtDbtr | Ultimate debtor | Object | Optional |
undrlyg.txInf.orgnlTxRef.dbtr | Debtor | Object | Required |
undrlyg.txInf.orgnlTxRef.dbtrAcct.id.iban | String | Required | |
undrlyg.txInf.orgnlTxRef.dbtrAgt.finInstnId.bicfi | String | Required | |
undrlyg.txInf.orgnlTxRef.cdtrAgt.finInstnId.bicfi | String | Required | |
undrlyg.txInf.orgnlTxRef.cdtr|Creditor | Object | Required | |
undrlyg.txInf.orgnlTxRef.cdtrAcct.id.iban | String | Required | |
undrlyg.txInf.orgnlTxRef.ultmtCdtr | Ultimate creditor | Object | Optional |
undrlyg.txInf.orgnlTxRef.purp | Purpose | Object | Optional |
Example request body:
{
"fitoFIPmtCxlReq": {
"assgnmt": {
"id": "MsgId-248234782374",
"assgnr": {
"agt": {
"finInstnId": {
"bicfi": "BSCHESMMXXX"
}
}
},
"assgne": {
"agt": {
"finInstnId": {
"bicfi": "BBVAESMMXXX"
}
}
},
"creDtTm": "2022-03-10T13:20:31.475+01:00"
},
"ctrlData": {
"nbOfTxs": 1
},
"undrlyg": [
{
"txInf": [
{
"cxlId": "TransactionId-{{msgId}}",
"orgnlGrpInf": {
"orgnlMsgId": "MsgId-248234782322",
"orgnlMsgNmId": "pacs.008.001.08"
},
"orgnlEndToEndId": "e2eId-34883473",
"orgnlTxId": "txId-383472833",
"orgnlIntrBkSttlmDt": {
"value": 10.04,
"ccy": "EUR"
},
"cxlRsnInf": [
{
"orgtr": {
"nm": "Mr Originator",
"id": {
"orgId": {
"anyBIC": "BSABESBBXXX"
}
}
},
"rsn": {
"cd": "CUST"
},
"addtlInf": [
"Ordered by customer"
]
}
],
"orgnlTxRef": {
"sttlmInf": {
"sttlmMtd": "CLRG",
"clrSys": {
"prtry": "ST2"
}
},
"pmtTpInf": {
"svcLvl": [
{
"cd": "SEPA"
}
]
},
"dbtr": {
"pty": {
"nm": "Mr. Debtor"
}
},
"dbtrAcct": {
"id": {
"iban": "ES9300492060833000002503"
}
},
"dbtrAgt": {
"finInstnId": {
"bicfi": "EBURESM1XXX"
}
},
"cdtr": {
"pty": {
"nm": "Mr. Creditor"
}
},
"cdtrAgt": {
"finInstnId": {
"bicfi": "BSCHGBM0XXX"
}
},
"cdtrAcct": {
"id": {
"iban": "GB91BARC20032634945865"
}
}
}
}
]
}
]
}
}
Request
The following example illustrates the request using raw HTTP code:
POST /payments/camt056/v08 HTTP/1.1
Host: sandbox.api.pagonxt.com
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
X-Client-Id: YOUR_CLIENT_ID
sca-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ikh1YnRlc3RfcHJvX3NhbmRib3gifQ.eyJoZCI6ImMrMkRKZEUyeklSTkNTS3hMVEU1TnIzVGpmQzRaVUFreTlxM0FuNFZLc3M9Iiwibm9uY2UiOiI2ZGNmOTgyZmM4ZTQ0YmVlOTRiYiIsImFsZyI6IlNIQTI1NiIsImlhdCI6MTY1NDUyNjUyMSwibmJmIjoxNjU0NTI2NTIxLCJleHAiOjE2ODYwNjI1MjEsImp0aSI6IjcwNDJjMjNhLWMzYmItNGU2MS04NjI4LTA1ZDRjODg2MWM0ZSJ9.KqRmUansjP5c-TRg8HcCS65x8I7w6EjT8xDQS83MoYMJiITAX50p1-gtnhtNAD-1l2CdUJfbyV9TzOn7qzm0uXx0rdWOaJ79efV5gEamc3jQNNFfhok9kwwKnlOX5d60UwGfLYbAJdZBZc49eyYRIojacTSVAewcKdXpTbwPPJE140WEYLwWkSXmUCPg1dPNyrogduHGl8DYEPdiaPytty-Bp9H_wApvQ5VAYmu111WzMCI0SPmo-eLGAj20C1sRVgKpl_-Puo-9gT2XOK1EBoD6qG_a2PaPuFxkAcm3W0-NtbEiYFnkvcS8zbMpHjdKq84qmh7Fq9ZsrsKgVJMfug
Content-Length: 3283
{
"fitoFIPmtCxlReq": {
"assgnmt": {
"id": "MsgId-248234782374",
"assgnr": {
"agt": {
"finInstnId": {
"bicfi": "BSCHESMMXXX"
}
}
},
"assgne": {
"agt": {
"finInstnId": {
"bicfi": "BBVAESMMXXX"
}
}
},
"creDtTm": "2022-03-10T13:20:31.475+01:00"
},
"ctrlData": {
"nbOfTxs": 1
},
"undrlyg": [
{
"txInf": [
{
"cxlId": "TransactionId-{{msgId}}",
"orgnlGrpInf": {
"orgnlMsgId": "MsgId-248234782322",
"orgnlMsgNmId": "pacs.008.001.08"
},
"orgnlEndToEndId": "e2eId-34883473",
"orgnlTxId": "txId-383472833",
"orgnlIntrBkSttlmDt": {
"value": 10.04,
"ccy": "EUR"
},
"cxlRsnInf": [
{
"orgtr": {
"nm": "Mr Originator",
"id": {
"orgId": {
"anyBIC": "BSABESBBXXX"
}
}
},
"rsn": {
"cd": "CUST"
},
"addtlInf": [
"Ordered by customer"
]
}
],
"orgnlTxRef": {
"sttlmInf": {
"sttlmMtd": "CLRG",
"clrSys": {
"prtry": "ST2"
}
},
"pmtTpInf": {
"svcLvl": [
{
"cd": "SEPA"
}
]
},
"dbtr": {
"pty": {
"nm": "Mr. Debtor"
}
},
"dbtrAcct": {
"id": {
"iban": "ES9300492060833000002503"
}
},
"dbtrAgt": {
"finInstnId": {
"bicfi": "EBURESM1XXX"
}
},
"cdtr": {
"pty": {
"nm": "Mr. Creditor"
}
},
"cdtrAgt": {
"finInstnId": {
"bicfi": "BSCHGBM0XXX"
}
},
"cdtrAcct": {
"id": {
"iban": "GB91BARC20032634945865"
}
}
}
}
]
}
]
}
}