This documentation is for WSO2 Open Banking version 1.5.0. View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

Consent Management APIs provide the capability to manage consents in a web application, on behalf of an end-user. A banking service consumer/ Account Servicing Payment Service Provider (ASPSP) may need to develop their own web application or use their own mechanism to deploy the consent management capabilities. At this point, a service provider needs a way to directly present consent resources to the end-user. In order to cater to this requirement, those consent capabilities (for example, consent creation/consent deletion) are presented as API resources in the Consent Management APIs.

The Payment Consent API provides payment consent capabilities as API resources. This API is secured with basic authentication. For more information, see configuring basic authentication for Consent Management APIs.

You can find the REST API documentation for Payments Information Sharing Consent Management APIs below:

Payment Information Sharing Consent Management API v1.1.0 (/consent/uk110) is deprecated in Open Banking 1.5.0. This feature and its functionalities will be unavailable from the next release (Open Banking 2.0.0).


Create payment consent 

Creates a payment initiation resource addressable under ConsentId with all data relevant for the corresponding payment product. This is the first step in the API to initiate the related payment.

POST /payments/{PaymentType}

curl -X POST \
  https://localhost:9446/consent/uk300/payments/domestic-payment-consents \
  -H 'Accept: application/json' -k \
  -H 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: Keep-Alive' \
  -H 'Content-Type: application/json' \
  -H 'Host: localhost:9446' \
  -H 'Transfer-Encoding: chunked' \
  -H 'User-Agent: Synapse-PT-HttpComponents-NIO' \
  -H 'charset: utf-8' \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-idempotency-key: 72633979' \
  -H 'x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTUwMTQ5NzY3MSwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImI2NCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiJ6UGEwYm5vanJYaGZSQXhlcHl6eDFJY2ltX1ZoVDgyMjR4SWFVVnVaSXlFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJFTUFJTEFERFJFU1M9bWFsc2hhbmlAd3NvMi5jb20sIENOPXRlc3RpbmcsIE9VPVFBLCBPPXdzbzIsIEw9TG9uZG9uLCBTVD1XZXN0ZXJuLCBDPVVLIiwiYWxnIjoiUFMyNTYifQ..FIUtqWg_3iwpZZWZFoSxTiPVKFbe6nxo6MGoMTmk3HoQ2DBkIUV9tsYRIFM7ODzc1b920S7ErjRAvS1kUYSh0QAJgnbh-sOoAgrSZrIu5VTszZJAyNAOGaOOpIlQuNT6tMwhoTK9t_ltuXUrMkg9K7z06tMQ32CQR3wYHmwyEJ3d67WJVJX2CumCYRvyreeXYqWN-k9WqtdS1u0w0tmJJIXkoHW4b_Z2P1QfRbCMBuOaIq2HBiFQV8WXCWvbGjPcz3dicENnh6de7gm9Y9MZYxLBlTqSdeMx5Z1YQOoymvdfCEUBt4FtltgIDkD8YtbdWb5oyeVFQbxBQchG8cM_rw' \
  -H 'x-wso2-client-id: TGWt8fqozunC1MVw8mAJSdO1eqIa' \
  -d '{
   "Data":{
      "Initiation":{
         "InstructionIdentification":"ACME412",
         "EndToEndIdentification":"FRESCO.21302.GFX.20",
         "InstructedAmount":{
            "Amount":"165.88",
            "Currency":"GBP"
         },
         "CreditorAccount":{
            "SchemeName":"UK.OBIE.SortCodeAccountNumber",
            "Identification":"08080021325698",
            "Name":"ACME Inc",
            "SecondaryIdentification":"0002"
         },
         "RemittanceInformation":{
            "Reference":"FRESCO-101",
            "Unstructured":"Internal ops code 5120101"
         }
      }
   },
   "Risk":{
      "PaymentContextCode":"EcommerceGoods",
      "MerchantCategoryCode":"5967",
      "MerchantCustomerIdentification":"053598653254",
      "DeliveryAddress":{
         "AddressLine":[
            "Flat 7",
            "Acacia Lodge"
         ],
         "StreetName":"Acacia Avenue",
         "BuildingNumber":"27",
         "PostCode":"GU31 2ZZ",
         "TownName":"Sparsholt",
         "CountrySubDivision":[
            "Wessex"
         ],
         "Country":"UK"
      }
   }
}'
{
   "Data":{
      "ConsentId":"bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8",
      "CreationDateTime":"2019-10-21T10:09:07Z",
      "Status":"AwaitingAuthorisation",
      "StatusUpdateDateTime":"2019-10-21T10:09:07Z",
      "Initiation":{
         "InstructionIdentification":"ACME412",
         "EndToEndIdentification":"FRESCO.21302.GFX.20",
         "InstructedAmount":{
            "Amount":"165.88",
            "Currency":"GBP"
         },
         "CreditorAccount":{
            "SchemeName":"UK.OBIE.SortCodeAccountNumber",
            "Identification":"08080021325698",
            "Name":"ACME Inc",
            "SecondaryIdentification":"0002"
         },
         "RemittanceInformation":{
            "Unstructured":"Internal ops code 5120101",
            "Reference":"FRESCO-101"
         }
      }
   },
   "Risk":{
      "PaymentContextCode":"EcommerceGoods",
      "MerchantCategoryCode":"5967",
      "MerchantCustomerIdentification":"053598653254",
      "DeliveryAddress":{
         "StreetName":"Acacia Avenue",
         "CountrySubDivision":[
            "Wessex"
         ],
         "AddressLine":[
            "Flat 7",
            "Acacia Lodge"
         ],
         "BuildingNumber":"27",
         "TownName":"Sparsholt",
         "Country":"UK",
         "PostCode":"GU31 2ZZ"
      }
   },
   "Links":{
      "Self":"https://localhost:8243/open-banking/{version}/pisp/domestic-payment-consents/bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8"
   },
   "Meta":{

   }
}

Retrieve payment consent 

This API resource retrieves information corresponding to the given ConsentId based on the type of the payment. 

GET /payments/{PaymentType}/{ConsentId}

curl -X GET \
  https://localhost:9446/consent/uk300/payments/domestic-payment-consents/bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8 \
  -H 'Accept: application/json' -k \
  -H 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: Keep-Alive' \
  -H 'Content-Type: application/json' \
  -H 'Host: localhost:9446' \
  -H 'User-Agent: Synapse-PT-HttpComponents-NIO' \
  -H 'charset: utf-8' \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-idempotency-key: 72633979' \
  -H 'x-wso2-client-id: TGWt8fqozunC1MVw8mAJSdO1eqIa'
{
   "Data":{
      "ConsentId":"bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8",
      "CreationDateTime":"2019-10-21T10:09:07Z",
      "Status":"AwaitingAuthorisation",
      "StatusUpdateDateTime":"2019-10-21T10:09:07Z",
      "Initiation":{
         "InstructionIdentification":"ACME412",
         "EndToEndIdentification":"FRESCO.21302.GFX.20",
         "InstructedAmount":{
            "Amount":"165.88",
            "Currency":"GBP"
         },
         "CreditorAccount":{
            "SchemeName":"UK.OBIE.SortCodeAccountNumber",
            "Identification":"08080021325698",
            "Name":"ACME Inc",
            "SecondaryIdentification":"0002"
         },
         "RemittanceInformation":{
            "Unstructured":"Internal ops code 5120101",
            "Reference":"FRESCO-101"
         }
      }
   },
   "Risk":{
      "PaymentContextCode":"EcommerceGoods",
      "MerchantCategoryCode":"5967",
      "MerchantCustomerIdentification":"053598653254",
      "DeliveryAddress":{
         "StreetName":"Acacia Avenue",
         "CountrySubDivision":[
            "Wessex"
         ],
         "AddressLine":[
            "Flat 7",
            "Acacia Lodge"
         ],
         "BuildingNumber":"27",
         "TownName":"Sparsholt",
         "Country":"UK",
         "PostCode":"GU31 2ZZ"
      }
   },
   "Links":{
      "Self":"https://localhost:8243/open-banking/{version}/pisp/domestic-payment-consents/bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8"
   },
   "Meta":{

   }
}

This API resource provides the payment consent link.

curl -X GET \
  https://localhost:9446/consent/uk300/payments/bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8/link \
  -H 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-wso2-client-id: TGWt8fqozunC1MVw8mAJSdO1eqIa' -k
{
 "link":"/consent/uk300/payments/domestic-payment-consents/bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8"
}

Update payment consent

This API resource updates a given payment consent.

PUT /payments/{PaymentType}/{ConsentId}/Consumption

curl -X PUT \
  https://localhost:9446/consent/uk300/payments/domestic-payment-consents/bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8/Consumption \
  -H 'Accept: application/json' -k \
  -H 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: Keep-Alive' \
  -H 'Content-Type: application/json' \
  -H 'Host: localhost:9446' \
  -H 'Transfer-Encoding: chunked' \
  -H 'User-Agent: Synapse-PT-HttpComponents-NIO' \
  -H 'charset: utf-8' \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTUwMTQ5NzY3MSwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImI2NCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiJ6UGEwYm5vanJYaGZSQXhlcHl6eDFJY2ltX1ZoVDgyMjR4SWFVVnVaSXlFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJFTUFJTEFERFJFU1M9bWFsc2hhbmlAd3NvMi5jb20sIENOPXRlc3RpbmcsIE9VPVFBLCBPPXdzbzIsIEw9TG9uZG9uLCBTVD1XZXN0ZXJuLCBDPVVLIiwiYWxnIjoiUFMyNTYifQ..FIUtqWg_3iwpZZWZFoSxTiPVKFbe6nxo6MGoMTmk3HoQ2DBkIUV9tsYRIFM7ODzc1b920S7ErjRAvS1kUYSh0QAJgnbh-sOoAgrSZrIu5VTszZJAyNAOGaOOpIlQuNT6tMwhoTK9t_ltuXUrMkg9K7z06tMQ32CQR3wYHmwyEJ3d67WJVJX2CumCYRvyreeXYqWN-k9WqtdS1u0w0tmJJIXkoHW4b_Z2P1QfRbCMBuOaIq2HBiFQV8WXCWvbGjPcz3dicENnh6de7gm9Y9MZYxLBlTqSdeMx5Z1YQOoymvdfCEUBt4FtltgIDkD8YtbdWb5oyeVFQbxBQchG8cM_rw' \
  -H 'x-wso2-client-id: TGWt8fqozunC1MVw8mAJSdO1eqIa' \
  -d '{
  "ConsentType": "domestic-payments",
  "PaymentType": "domestic-payments",
  "MetaData": [
    {
      "MetadataKey": "domestic-payments",
      "MetadataValue": "domestic-payments"
    }
  ],
  "Status": "Authorised"
}
'
200 OK

Update payment consent status

This API resource updates the status of a given payment consent.

PUT /payments/{PaymentType}/{ConsentId}/status/{Status}

curl -X PUT \
  https://localhost:9446/consent/uk300/payments/domestic-payment-consents/bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8/status/Authorised \
  -k -H 'Accept: application/json'  \
  -H 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: Keep-Alive' \
  -H 'Content-Type: application/json' \
  -H 'Host: localhost:9446' \
  -H 'Transfer-Encoding: chunked' \
  -H 'User-Agent: Synapse-PT-HttpComponents-NIO' \
  -H 'charset: utf-8'
200 OK

Persist payment consent

This resource is to update a payment consent resource and bind it with a PSU.

POST /payment-consents

curl -X POST \
  https://localhost:9446/consent/uk300/payment-consents \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: Keep-Alive' \
  -H 'Content-Type: application/json' \
  -H 'Host: localhost:9446' \
  -H 'Transfer-Encoding: chunked' \
  -H 'User-Agent: Synapse-PT-HttpComponents-NIO' \
  -H 'charset: utf-8' \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-idempotency-key: 72633979' \
  -H 'x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTUwMTQ5NzY3MSwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImI2NCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiJ6UGEwYm5vanJYaGZSQXhlcHl6eDFJY2ltX1ZoVDgyMjR4SWFVVnVaSXlFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJFTUFJTEFERFJFU1M9bWFsc2hhbmlAd3NvMi5jb20sIENOPXRlc3RpbmcsIE9VPVFBLCBPPXdzbzIsIEw9TG9uZG9uLCBTVD1XZXN0ZXJuLCBDPVVLIiwiYWxnIjoiUFMyNTYifQ..FIUtqWg_3iwpZZWZFoSxTiPVKFbe6nxo6MGoMTmk3HoQ2DBkIUV9tsYRIFM7ODzc1b920S7ErjRAvS1kUYSh0QAJgnbh-sOoAgrSZrIu5VTszZJAyNAOGaOOpIlQuNT6tMwhoTK9t_ltuXUrMkg9K7z06tMQ32CQR3wYHmwyEJ3d67WJVJX2CumCYRvyreeXYqWN-k9WqtdS1u0w0tmJJIXkoHW4b_Z2P1QfRbCMBuOaIq2HBiFQV8WXCWvbGjPcz3dicENnh6de7gm9Y9MZYxLBlTqSdeMx5Z1YQOoymvdfCEUBt4FtltgIDkD8YtbdWb5oyeVFQbxBQchG8cM_rw' \
  -H 'x-wso2-client-id: TGWt8fqozunC1MVw8mAJSdO1eqIa' -k \
  -d '{
"paymentRequestId" : "bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8",
"status" : "Authorised",
"collectionMethod" : "test",
"userId" : "test@wso2.com@carbon.super",
"accountId" : "888812345678"
}'
{
   "paymentRequestId":"bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8",
   "status":"Authorised",
   "collectionMethod":"test",
   "userId":"test@wso2.com@carbon.super",
   "accountId":"888812345678"
}


Retrieve payment consent 

This API resource is to retrieve a payment consent using the given ConsentId.

GET /payment-consents/{ConsentId}

curl -X GET \
  https://localhost:9446/consent/uk300/payment-consents/bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8 \
  -H 'Accept: application/json' -k \
  -H 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: Keep-Alive' \
  -H 'Content-Type: application/json' \
  -H 'Host: localhost:9446' \
  -H 'User-Agent: Synapse-PT-HttpComponents-NIO' \
  -H 'charset: utf-8'
{
   "accountId":"888812345678",
   "userId":"test@wso2.com@carbon.super",
   "collectionMethod":"test",
   "paymentId":"bfd1fc86-2686-4ad5-923c-e2bcc9c9b9d8"
}

Upload file for the File Payment consent

This resource allows uploading a file to an ASPSP, against a file-payment-consent resource.

POST /payments/{PaymentType}/{ConsentId}/file

 Click here to see a sample request and response
curl -X POST \
  https://localhost:9446/consent/uk300/payments/file-payments-consent/4427fbd1-c4fc-4e15-9520-1eec9fc22597/file \
  -H 'Accept: application/json' -k \
  -H 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: Keep-Alive' \
  -H 'Content-Type: text/xml' \
  -H 'Host: localhost:9446' \
  -H 'Postman-Token: 88a81b40-b5a0-472c-8874-0dd4970b195a' \
  -H 'Transfer-Encoding: chunked' \
  -H 'User-Agent: Synapse-PT-HttpComponents-NIO' \
  -H 'charset: utf-8' \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-idempotency-key: 123345' \
  -H 'x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTUwMTQ5NzY3MSwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJvcGVuYmFua2luZy5vcmcudWsiLCJjcml0IjpbImI2NCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaWF0IiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyJdLCJraWQiOiJ6UGEwYm5vanJYaGZSQXhlcHl6eDFJY2ltX1ZoVDgyMjR4SWFVVnVaSXlFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJFTUFJTEFERFJFU1M9bWFsc2hhbmlAd3NvMi5jb20sIENOPXRlc3RpbmcsIE9VPVFBLCBPPXdzbzIsIEw9TG9uZG9uLCBTVD1XZXN0ZXJuLCBDPVVLIiwiYWxnIjoiUFMyNTYifQ..FIUtqWg_3iwpZZWZFoSxTiPVKFbe6nxo6MGoMTmk3HoQ2DBkIUV9tsYRIFM7ODzc1b920S7ErjRAvS1kUYSh0QAJgnbh-sOoAgrSZrIu5VTszZJAyNAOGaOOpIlQuNT6tMwhoTK9t_ltuXUrMkg9K7z06tMQ32CQR3wYHmwyEJ3d67WJVJX2CumCYRvyreeXYqWN-k9WqtdS1u0w0tmJJIXkoHW4b_Z2P1QfRbCMBuOaIq2HBiFQV8WXCWvbGjPcz3dicENnh6de7gm9Y9MZYxLBlTqSdeMx5Z1YQOoymvdfCEUBt4FtltgIDkD8YtbdWb5oyeVFQbxBQchG8cM_rw' \
  -H 'x-wso2-client-id: TGWt8fqozunC1MVw8mAJSdO1eqIa' \
  -d '<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.001.001.08" xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance">
    <CstmrCdtTrfInitn>
    <GrpHdr>
        <MsgId>ABC/120928/CCT001</MsgId>
        <CreDtTm>2012-09-28T14:07:00</CreDtTm>
        <NbOfTxs>3</NbOfTxs>
        <CtrlSum>11500000</CtrlSum>
        <InitgPty>
            <Nm>ABC Corporation</Nm>
            <PstlAdr>
                <StrtNm>Times Square</StrtNm>
                <BldgNb>7</BldgNb>
                <PstCd>NY 10036</PstCd>
                <TwnNm>New York</TwnNm>
                <Ctry>US</Ctry>
            </PstlAdr>
        </InitgPty>
    </GrpHdr>
    <PmtInf>
        <PmtInfId>ABC/086</PmtInfId>
        <PmtMtd>TRF</PmtMtd>
        <BtchBookg>false</BtchBookg>
        <ReqdExctnDt>
            <Dt>2012-09-29</Dt>
        </ReqdExctnDt>
        <Dbtr>
            <Nm>ABC Corporation</Nm>
            <PstlAdr>
                <StrtNm>Times Square</StrtNm>
                <BldgNb>7</BldgNb>
                <PstCd>NY 10036</PstCd>
                <TwnNm>New York</TwnNm>
                <Ctry>US</Ctry>
            </PstlAdr>
        </Dbtr>
        <DbtrAcct>
            <Id>
                <Othr>
                    <Id>00125574999</Id>
                </Othr>
            </Id>
        </DbtrAcct>
        <DbtrAgt>
            <FinInstnId>
                <BICFI>BBBBUS33</BICFI>
            </FinInstnId>
        </DbtrAgt>
        <CdtTrfTxInf>
            <PmtId>
                <InstrId>ABC/120928/CCT001/01</InstrId>
                <EndToEndId>ABC/4562/2012-09-08</EndToEndId>
            </PmtId>
            <Amt>
                <InstdAmt Ccy="JPY">10000000</InstdAmt>
            </Amt>
            <ChrgBr>SHAR</ChrgBr>
            <CdtrAgt>
                <FinInstnId>
                    <BICFI>AAAAGB2L</BICFI>
                </FinInstnId>
            </CdtrAgt>
            <Cdtr>
                <Nm>DEF Electronics</Nm>
                <PstlAdr>
                    <AdrLine>Corn Exchange 5th Floor</AdrLine>
                    <AdrLine>Mark Lane 55</AdrLine>
                    <AdrLine>EC3R7NE London</AdrLine>
                    <AdrLine>GB</AdrLine>
                </PstlAdr>
            </Cdtr>
            <CdtrAcct>
                <Id>
                    <Othr>
                        <Id>23683707994125</Id>
                    </Othr>
                </Id>
            </CdtrAcct>
            <Purp>
                <Cd>GDDS</Cd>
            </Purp>
            <RmtInf>
                <Strd>
                    <RfrdDocInf>
                        <Tp>
                            <CdOrPrtry>
                                <Cd>CINV</Cd>
                            </CdOrPrtry>
                        </Tp>
                        <Nb>4562</Nb>
                        <RltdDt>2012-09-08</RltdDt>
                    </RfrdDocInf>
                </Strd>
            </RmtInf>
        </CdtTrfTxInf>
        <CdtTrfTxInf>
            <PmtId>
                <InstrId>ABC/120928/CCT001/2</InstrId>
                <EndToEndId>ABC/ABC-13679/2012-09-15</EndToEndId>
            </PmtId>
            <Amt>
                <InstdAmt Ccy="EUR">500000</InstdAmt>
            </Amt>
            <ChrgBr>CRED</ChrgBr>
            <CdtrAgt>
                <FinInstnId>
                    <BICFI>DDDDBEBB</BICFI>
                </FinInstnId>
            </CdtrAgt>
            <Cdtr>
                <Nm>GHI Semiconductors</Nm>
                <PstlAdr>
                    <StrtNm>Avenue Brugmann</StrtNm>
                    <BldgNb>415</BldgNb>
                    <PstCd>1180</PstCd>
                    <TwnNm>Brussels</TwnNm>
                    <Ctry>BE</Ctry>
                </PstlAdr>
            </Cdtr>
            <CdtrAcct>
                <Id>
                    <IBAN>BE30001216371411</IBAN>
                </Id>
            </CdtrAcct>
            <InstrForCdtrAgt>
                <Cd>PHOB</Cd>
                <InstrInf>+32/2/2222222</InstrInf>
            </InstrForCdtrAgt>
            <Purp>
                <Cd>GDDS</Cd>
            </Purp>
            <RmtInf>
                <Strd>
                    <RfrdDocInf>
                        <Tp>
                            <CdOrPrtry>
                                <Cd>CINV</Cd>
                            </CdOrPrtry>
                        </Tp>
                        <Nb>ABC-13679</Nb>
                        <RltdDt>2012-09-15</RltdDt>
                    </RfrdDocInf>
                </Strd>
            </RmtInf>
        </CdtTrfTxInf>
        <CdtTrfTxInf>
            <PmtId>
                <InstrId>ABC/120928/CCT001/3</InstrId>
                <EndToEndId>ABC/987-AC/2012-09-27</EndToEndId>
            </PmtId>
            <Amt>
                <InstdAmt Ccy="USD">1000000</InstdAmt>
            </Amt>
            <ChrgBr>SHAR</ChrgBr>
            <CdtrAgt>
                <FinInstnId>
                    <BICFI>BBBBUS66</BICFI>
                </FinInstnId>
            </CdtrAgt>
            <Cdtr>
                <Nm>ABC Corporation</Nm>
                <PstlAdr>
                    <Dept>Treasury department</Dept>
                    <StrtNm>Bush Street</StrtNm>
                    <BldgNb>13</BldgNb>
                    <PstCd>CA 94108</PstCd>
                    <TwnNm>San Francisco</TwnNm>
                    <Ctry>US</Ctry>
                </PstlAdr>
            </Cdtr>
            <CdtrAcct>
                <Id>
                    <Othr>
                        <Id>4895623</Id>
                    </Othr>
                </Id>
            </CdtrAcct>
            <Purp>
                <Cd>INTC</Cd>
            </Purp>
            <RmtInf>
                <Strd>
                    <RfrdDocInf>
                        <Tp>
                            <CdOrPrtry>
                                <Cd>CINV</Cd>
                            </CdOrPrtry>
                        </Tp>
                        <Nb>987-AC</Nb>
                        <RltdDt>2012-09-27</RltdDt>
                    </RfrdDocInf>
                </Strd>
            </RmtInf>
        </CdtTrfTxInf>
    </PmtInf>
</CstmrCdtTrfInitn>
</Document>'
200 OK

Retrieve file from the File Payment consent

The API endpoint allows downloading a file that had been uploaded against a file-payment-consent resource. HTTP headers are used to describe the file.

GET /payments/{PaymentType}/{ConsentId}/file

 Click here to see a sample request and response
curl -X GET \
  https://localhost:9446/consent/uk300/payments/file-payments-consent/4427fbd1-c4fc-4e15-9520-1eec9fc22597/file \
  -H 'Authorization: Basic YWRtaW5Ad3NvMi5jb206d3NvMjEyMw==' -k \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: Keep-Alive' \
  -H 'Content-Type: application/xml' \
  -H 'Host: localhost:9446' \
  -H 'Postman-Token: 8c90171f-416a-483f-be89-3dafcb421f2b' \
  -H 'Transfer-Encoding: chunked' \
  -H 'User-Agent: Synapse-PT-HttpComponents-NIO' \
  -H 'charset: utf-8' \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-wso2-client-id: TGWt8fqozunC1MVw8mAJSdO1eqIa'
<?xml version="1.0" encoding="UTF-8" ?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.001.001.08" xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance">
    <CstmrCdtTrfInitn>
    <GrpHdr>
        <MsgId>ABC/120928/CCT001</MsgId>
        <CreDtTm>2012-09-28T14:07:00</CreDtTm>
        <NbOfTxs>3</NbOfTxs>
        <CtrlSum>11500000</CtrlSum>
        <InitgPty>
            <Nm>ABC Corporation</Nm>
            <PstlAdr>
                <StrtNm>Times Square</StrtNm>
                <BldgNb>7</BldgNb>
                <PstCd>NY 10036</PstCd>
                <TwnNm>New York</TwnNm>
                <Ctry>US</Ctry>
            </PstlAdr>
        </InitgPty>
    </GrpHdr>
    <PmtInf>
        <PmtInfId>ABC/086</PmtInfId>
        <PmtMtd>TRF</PmtMtd>
        <BtchBookg>false</BtchBookg>
        <ReqdExctnDt>
            <Dt>2012-09-29</Dt>
        </ReqdExctnDt>
        <Dbtr>
            <Nm>ABC Corporation</Nm>
            <PstlAdr>
                <StrtNm>Times Square</StrtNm>
                <BldgNb>7</BldgNb>
                <PstCd>NY 10036</PstCd>
                <TwnNm>New York</TwnNm>
                <Ctry>US</Ctry>
            </PstlAdr>
        </Dbtr>
        <DbtrAcct>
            <Id>
                <Othr>
                    <Id>00125574999</Id>
                </Othr>
            </Id>
        </DbtrAcct>
        <DbtrAgt>
            <FinInstnId>
                <BICFI>BBBBUS33</BICFI>
            </FinInstnId>
        </DbtrAgt>
        <CdtTrfTxInf>
            <PmtId>
                <InstrId>ABC/120928/CCT001/01</InstrId>
                <EndToEndId>ABC/4562/2012-09-08</EndToEndId>
            </PmtId>
            <Amt>
                <InstdAmt Ccy="JPY">10000000</InstdAmt>
            </Amt>
            <ChrgBr>SHAR</ChrgBr>
            <CdtrAgt>
                <FinInstnId>
                    <BICFI>AAAAGB2L</BICFI>
                </FinInstnId>
            </CdtrAgt>
            <Cdtr>
                <Nm>DEF Electronics</Nm>
                <PstlAdr>
                    <AdrLine>Corn Exchange 5th Floor</AdrLine>
                    <AdrLine>Mark Lane 55</AdrLine>
                    <AdrLine>EC3R7NE London</AdrLine>
                    <AdrLine>GB</AdrLine>
                </PstlAdr>
            </Cdtr>
            <CdtrAcct>
                <Id>
                    <Othr>
                        <Id>23683707994125</Id>
                    </Othr>
                </Id>
            </CdtrAcct>
            <Purp>
                <Cd>GDDS</Cd>
            </Purp>
            <RmtInf>
                <Strd>
                    <RfrdDocInf>
                        <Tp>
                            <CdOrPrtry>
                                <Cd>CINV</Cd>
                            </CdOrPrtry>
                        </Tp>
                        <Nb>4562</Nb>
                        <RltdDt>2012-09-08</RltdDt>
                    </RfrdDocInf>
                </Strd>
            </RmtInf>
        </CdtTrfTxInf>
        <CdtTrfTxInf>
            <PmtId>
                <InstrId>ABC/120928/CCT001/2</InstrId>
                <EndToEndId>ABC/ABC-13679/2012-09-15</EndToEndId>
            </PmtId>
            <Amt>
                <InstdAmt Ccy="EUR">500000</InstdAmt>
            </Amt>
            <ChrgBr>CRED</ChrgBr>
            <CdtrAgt>
                <FinInstnId>
                    <BICFI>DDDDBEBB</BICFI>
                </FinInstnId>
            </CdtrAgt>
            <Cdtr>
                <Nm>GHI Semiconductors</Nm>
                <PstlAdr>
                    <StrtNm>Avenue Brugmann</StrtNm>
                    <BldgNb>415</BldgNb>
                    <PstCd>1180</PstCd>
                    <TwnNm>Brussels</TwnNm>
                    <Ctry>BE</Ctry>
                </PstlAdr>
            </Cdtr>
            <CdtrAcct>
                <Id>
                    <IBAN>BE30001216371411</IBAN>
                </Id>
            </CdtrAcct>
            <InstrForCdtrAgt>
                <Cd>PHOB</Cd>
                <InstrInf>+32/2/2222222</InstrInf>
            </InstrForCdtrAgt>
            <Purp>
                <Cd>GDDS</Cd>
            </Purp>
            <RmtInf>
                <Strd>
                    <RfrdDocInf>
                        <Tp>
                            <CdOrPrtry>
                                <Cd>CINV</Cd>
                            </CdOrPrtry>
                        </Tp>
                        <Nb>ABC-13679</Nb>
                        <RltdDt>2012-09-15</RltdDt>
                    </RfrdDocInf>
                </Strd>
            </RmtInf>
        </CdtTrfTxInf>
        <CdtTrfTxInf>
            <PmtId>
                <InstrId>ABC/120928/CCT001/3</InstrId>
                <EndToEndId>ABC/987-AC/2012-09-27</EndToEndId>
            </PmtId>
            <Amt>
                <InstdAmt Ccy="USD">1000000</InstdAmt>
            </Amt>
            <ChrgBr>SHAR</ChrgBr>
            <CdtrAgt>
                <FinInstnId>
                    <BICFI>BBBBUS66</BICFI>
                </FinInstnId>
            </CdtrAgt>
            <Cdtr>
                <Nm>ABC Corporation</Nm>
                <PstlAdr>
                    <Dept>Treasury department</Dept>
                    <StrtNm>Bush Street</StrtNm>
                    <BldgNb>13</BldgNb>
                    <PstCd>CA 94108</PstCd>
                    <TwnNm>San Francisco</TwnNm>
                    <Ctry>US</Ctry>
                </PstlAdr>
            </Cdtr>
            <CdtrAcct>
                <Id>
                    <Othr>
                        <Id>4895623</Id>
                    </Othr>
                </Id>
            </CdtrAcct>
            <Purp>
                <Cd>INTC</Cd>
            </Purp>
            <RmtInf>
                <Strd>
                    <RfrdDocInf>
                        <Tp>
                            <CdOrPrtry>
                                <Cd>CINV</Cd>
                            </CdOrPrtry>
                        </Tp>
                        <Nb>987-AC</Nb>
                        <RltdDt>2012-09-27</RltdDt>
                    </RfrdDocInf>
                </Strd>
            </RmtInf>
        </CdtTrfTxInf>
    </PmtInf>
</CstmrCdtTrfInitn>
</Document>
  • No labels