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

The BankToCustomerStatement message is sent by the account servicer to an account owner or to a party authorised by the account owner to receive the message. It is used to inform the account owner, or authorised party, of the entries booked to the account, and to provide the owner with balance information on the account at a given point in time.

The CAMT.053 (camt.053.001.06 BankToCustomerAccountStatementV06) is an end of day statement message.

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

How it works¶

In order to get delivered with a CAMT 053 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 and wait for it to issue a new statement, catching the event your client has been subscribed to; * get the XML 20022 CAMT.053 file directly from an uri provided in a json attribute of the job;

Get further reading the peculiarities of time ranged statements.

Date Ranged Statements¶

In order to get CAMT.053.001 statements produced you can set attributes to define the date range issuing. date_range_statement is an optional attribute.

Date-time and durations are ISO 8601 compliant representations.

  "date_range_statement": {
      "begin": "2016-07-16",
      "end": "2016-07-16",
      "duration": "P2M"
    },

Semanthics of date range are listed in the table below:

Statements 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 date_range_statement is not passed in, DropPay will issue statements setting a default date range beginning at 00:00 of the current day and ending at the time the request is performed.

CAMT 053 Versioning¶

Currently DropPay supports only Version 6 of CAMT 053.

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

    "version": "001.006",

CAMT 053 DropPay specification¶

You can find XML schema specified as a formatted table in the document DropPay-ISO20022-CAMT.053.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 053.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 053 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/053/
--header 'authorization: Bearer ac9185e9f2984867b11069fd2881ff1a'
--header 'content-type:application/json'

{
    "description `my wonderful unstoppable job`": "",
    "version": "001.006",
    "iban": "IT00A1000010000393471122333",
    "date_range_statement": {
        "begin": "2016-07-16",
        "end": "2016-07-16",
        "duration": "P2M"
    },

}

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

    "status": "DRAFT",
    "webhooks": {
        "camt053": "https://credenA:credenB@app.server.com/listener"
    },
    "statements": [
        {
            "date_issue": "2016-07-16T19:20:30+01:00",
            "file": "https://api.drop-pay.io/bank/iso20022/v1/reports/ISO145123G6YY/RPT523623G6YY"
        }
    ],
}

    {
        "code": "100",
        "description": "Missing arguments"
    }

curl --request PATCH
--url https://api.drop-pay.io/bank/iso20022/v1/camt/053/{id}
--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",
    "date_range_statement": {
        "begin": "2016-07-16",
        "end": "2016-07-16",
        "duration": "P2M"
        },

    "status": "SCHEDULED",
    "webhooks": {
        "camt053": "https://credenA:credenB@app.server.com/listener"
    },
    "statements": [
        {
            "date_issue": "2016-07-16T19:20:30+01:00",
            "file": "https://api.drop-pay.io/bank/iso20022/v1/reports/ISO145123G6YY/RPT523623G6YY"
        }
    ],
}

    {
        "code": "100",
        "description": "Missing arguments"
    }

curl --request GET
--url https://api.drop-pay.io/bank/iso20022/v1/camt/053/{id}
--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",
    "date_range_statement": {
        "begin": "2016-07-16",
        "end": "2016-07-16",
        "duration": "P2M"
        },

    "status": "DRAFT",
    "webhooks": {
        "camt053": "https://credenA:credenB@app.server.com/listener"
    },
    "statements": [
        {
            "date_issue": "2016-07-16T19:20:30+01:00",
            "file": "https://api.drop-pay.io/bank/iso20022/v1/reports/ISO145123G6YY/RPT523623G6YY"
        }
    ],
}

    {
        "code": "100",
        "description": "Missing arguments"
    }

curl --request DELETE
--url https://api.drop-pay.io/bank/iso20022/v1/camt/053/{id}
--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",
    "date_range_statement": {
        "begin": "2016-07-16",
        "end": "2016-07-16",
        "duration": "P2M"
        },

    "status": "CANCELLED",
    "webhooks": {
        "camt053": "https://credenA:credenB@app.server.com/listener"
    },
    "statements": [
        {
            "date_issue": "2016-07-16T19:20:30+01:00",
            "file": "https://api.drop-pay.io/bank/iso20022/v1/reports/ISO145123G6YY/RPT523623G6YY"
        }
    ],
}

    {
        "code": "100",
        "description": "Missing arguments"
    }

Listing CAMT 053 jobs¶

curl --request GET
--url https://api.drop-pay.io/bank/iso20022/v1/camt/053s/{?iban,status,description,date_from,date_to,pg_offset,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": {
        "camt053": "https://credenA:credenB@app.server.com/listener"
    },

Events of useful status updates¶

Event fired when a new camt.053 statement is delivered.

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

Event fired when a camt.053 job is complete.

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