DropPay API - Bank v.1 - ISO 20022 Messages - Bank to Customer Report (CAMT.052)¶

The account report (camt.052.001.02 BankToCustomerAccountReportV06) description is used for reporting intra-day transactions and balances.

The CAMT.052 is usually an intraday report message. Nevertheless DropPay will provide this type of message by putting you in control of which day and time you want the report being referred to, that is you can decide which day your system is running in, today or any day before today.

And more, you can ask DropPay to produce the report with a time range wider than the 24h of selected day.

How it works¶

In order to get delivered with a CAMT 052 you have to:

• POST a request that initializes a job with desired parameters in a json object;
• PATCH the job resource until it's ready to be launched;
• make the job run (PATCH the status to be READY) and wait for it to issue a new report, catching the event your client has been subscribed to;
• get the XML 20022 CAMT.052 file directly from an uri provided in a json attribute of the job;

Get further reading all the details time ranged reports.

Time Rangd Reports¶

In order to get CAMT.052.001 reports produced you can set attributes to define the time range. report_time_range attribute is optional.

Date-time and durations are ISO 8601 compliant representations.

  "time_range_report": {
      "begin": "2016-07-16T19:20:30+01:00",
      "end": "2016-07-16T19:20:30+01:00",
      "duration": "P2M"
    },

Semanthics of time ranges are listed in the table below:

Reports can be produced scheduling a job and then fetching resulting files once job status switch to, DONE or CANCELLED. Files will be available until 48 hours after the status has changed to DONEor CANCELLED. Late fetches will result in a 410/500 HTTP Status Error.

Default range¶

If time_range_report is not passed in, DropPay will issue reports setting a default time range beginning at 00:00 of the current day and ending at the time the request is performed.

CAMT 052 Versioning¶

Currently DropPay supports only Version 6 of CAMT 052.

Anyway if any other version compliance will be added in the future, you'll be able to require DropPay to produce CAMT 052 reports accordingly with the version set as job attribute.

    "version": "001.006",

CAMT 052 DropPay specification¶

You can find XML schema specified as a formatted table in the document DropPay-ISO20022-CAMT.052.001.pdf

REST Entities¶

Every REST entity is described listing her properties with the following formatting conventions:

• this is a property name
• this is an example of property value
• (type, policy, direction) is the specification of a property
  • type can be "string", "number", "object" or a proper object class name
  • policy can be "optional" or "required"
  • direction can be "posted" or "received" depending on whether you set it in the request or you got it from the response
• after the dash "-" there's the property description

name: example_value (type, policy, direction) - Property description

CAMT 052.001¶

REST Endpoints¶

Security¶

Requests must be authenticated with User Access Token. User Access Token can be obtained requesting it with and active Connection Code.

Details at Authentication v.1 API Reference

Manage CAMT 052 jobs¶

DropPay Push API publishes the following methods :

• POST a new Push order entity to send money
• GET the Push order entity to read the order status;
• PATCH the Push order entity to modify the order attributes until it is set with second factor disposition protocol;
• DELETE the Push order entity

curl --request POST
--url https://api.drop-pay.io/bank/iso20022/v1/camt/052/
--header 'authorization: Bearer ac9185e9f2984867b11069fd2881ff1a'
--header 'content-type:application/json'

{
    "description `my wonderful unstoppable job`": "",
    "version": "001.006",
    "iban": "IT00A1000010000393471122333",
    "time_range_report": {
        "begin": "2016-07-16T19:20:30+01:00",
        "end": "2016-07-16T19:20:30+01:00",
        "duration": "P2M"
    },
}

{
    "id": "ISO145123G6YY",
    "description": "my wonderful unstoppable job",
    "version": "001.006",
    "date_creation": "2016-07-16T19:20:30+01:00",
    "iban": "IT00A1000010000393471122333",
    "time_range_report": {
        "begin": "2016-07-16T19:20:30+01:00",
        "end": "2016-07-16T19:20:30+01:00",
        "duration": "P2M"
        },
    "status": "DRAFT",
    "webhooks": {
        "camt052": "https://credenA:credenB@app.server.com/listener"
    },
    "reports": [
        {
            "date_issue": "2016-07-16T19:20:30+01:00",
            "file": "https://api.drop-pay.io/bank/iso20022/v1/reports/ISO145123G6YY/RPT523623G6YY"
        }
    ],
}

curl --request PATCH
--url https://api.drop-pay.io/bank/iso20022/v1/camt/052/ISO145123G6YY
--header 'Authorization: Bearer ac9185e9f2984867b11069fd2881ff1a'
--header 'Content-type: application/json'

{
     "status": "SCHEDULED"
}

{
    "id": "ISO145123G6YY",
    "description": "my wonderful unstoppable job",
    "version": "001.006",
    "date_creation": "2016-07-16T19:20:30+01:00",
    "iban": "IT00A1000010000393471122333",
    "time_range_report": {
        "begin": "2016-07-16T19:20:30+01:00",
        "end": "2016-07-16T19:20:30+01:00",
        "duration": "P2M"
        },
    "status": "SCHEDULED",
    "webhooks": {
        "camt052": "https://credenA:credenB@app.server.com/listener"
    },
    "reports": [
        {
            "date_issue": "2016-07-16T19:20:30+01:00",
            "file": "https://api.drop-pay.io/bank/iso20022/v1/reports/ISO145123G6YY/RPT523623G6YY"
        }
    ],
}

curl --request GET
--url https://api.drop-pay.io/bank/iso20022/v1/camt/052/ISO145123G6YY
--header 'Authorization: Bearer ac9185e9f2984867b11069fd2881ff1a'

{
    "id": "ISO145123G6YY",
    "description": "my wonderful unstoppable job",
    "version": "001.006",
    "date_creation": "2016-07-16T19:20:30+01:00",
    "iban": "IT00A1000010000393471122333",
    "time_range_report": {
        "begin": "2016-07-16T19:20:30+01:00",
        "end": "2016-07-16T19:20:30+01:00",
        "duration": "P2M"
        },
    "status": "DRAFT",
    "webhooks": {
        "camt052": "https://credenA:credenB@app.server.com/listener"
    },
    "reports": [
        {
            "date_issue": "2016-07-16T19:20:30+01:00",
            "file": "https://api.drop-pay.io/bank/iso20022/v1/reports/ISO145123G6YY/RPT523623G6YY"
        }
    ],
}

curl --request DELETE
--url https://api.drop-pay.io/bank/iso20022/v1/camt/052/ISO145123G6YY
--header 'Authorization: Bearer ac9185e9f2984867b11069fd2881ff1a'

{
    "id": "ISO145123G6YY",
    "description": "my wonderful unstoppable job",
    "version": "001.006",
    "date_creation": "2016-07-16T19:20:30+01:00",
    "iban": "IT00A1000010000393471122333",
    "time_range_report": {
        "begin": "2016-07-16T19:20:30+01:00",
        "end": "2016-07-16T19:20:30+01:00",
        "duration": "P2M"
        },
    "status": "CANCELLED",
    "webhooks": {
        "camt052": "https://credenA:credenB@app.server.com/listener"
    },
    "reports": [
        {
            "date_issue": "2016-07-16T19:20:30+01:00",
            "file": "https://api.drop-pay.io/bank/iso20022/v1/reports/ISO145123G6YY/RPT523623G6YY"
        }
    ],
}

Listing CAMT 052 jobs¶

curl --request GET
--url https://api.drop-pay.io/bank/iso20022/v1/camt/052s/{?iban,status,description,date_from,date_to,pg_num,pg_size}
--header 'Authorization: Bearer ac9185e9f2984867b11069fd2881ff1a'

        }
    ],
    "paging_info": {
        "current_page": 0,
        "total_pages": 0,
        "page_size": 0,
        "total_items": 0
    }
}
```

Group Webhooks & Events¶

Webhooks & Events¶

Your Application can subscribe to the following webhooks

Add a webhook property as show below.

    "webhooks": {
        "camt052": "https://credenA:credenB@app.server.com/listener"
    },

Events of useful status updates¶

Event fired when a new camt.052 report is delivered.

{
    "etime": "2017-06-30T12:00:00+01:00",
    "etype": "iso20022.camt052.issued",
    "edata": { A CAMT052 entity }
}

Event fired when a camt.052 job is complete.

{
    "etime": "2017-06-30T12:00:00+01:00",
    "etype": "iso20022.camt052.done",
    "edata": { A CAMT052 entity }
}