This documentation is for WSO2 Open Banking version 1.4.0. View documentation for the latest release.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleClick here to see how it is done

POST /international-scheduled-payment-consents

The API endpoint allows the PISP to ask an ASPSP to create a new international-scheduled-payment-consent resource. The ASPSP creates the resource and responds with a unique ConsentId to refer to the resource.

  • Use the following format in the consent body.

    Code Block
    {
      "Data": {
        "Permission": "Create",
        "Initiation": {
          "InstructionIdentification": "string",
          "EndToEndIdentification": "string",
          "LocalInstrument": [
            "UK.OBIE.BACS",
            "UK.OBIE.BalanceTransfer",
            "UK.OBIE.CHAPS",
            "UK.OBIE.Euro1",
            "UK.OBIE.FPS",
            "UK.OBIE.Link",
            "UK.OBIE.MoneyTransfer",
            "UK.OBIE.Paym",
            "UK.OBIE.SEPACreditTransfer",
            "UK.OBIE.SEPAInstantCreditTransfer",
            "UK.OBIE.SWIFT",
            "UK.OBIE.Target2"
          ],
          "InstructionPriority": "Normal",
          "Purpose": "string",
          "ChargeBearer": "BorneByCreditor",
          "RequestedExecutionDateTime": "2019-07-28T07:45:47.510Z",
          "CurrencyOfTransfer": "string",
          "InstructedAmount": {
            "Amount": "string",
            "Currency": "string"
          },
          "ExchangeRateInformation": {
            "UnitCurrency": "string",
            "ExchangeRate": 0,
            "RateType": "Actual",
            "ContractIdentification": "string"
          },
          "DebtorAccount": {
            "SchemeName": [
              "UK.OBIE.BBAN",
              "UK.OBIE.IBAN",
              "UK.OBIE.PAN",
              "UK.OBIE.Paym",
              "UK.OBIE.SortCodeAccountNumber"
            ],
            "Identification": "string",
            "Name": "string",
            "SecondaryIdentification": "string"
          },
          "Creditor": {
            "Name": "string",
            "PostalAddress": {
              "AddressType": "Business",
              "Department": "string",
              "SubDepartment": "string",
              "StreetName": "string",
              "BuildingNumber": "string",
              "PostCode": "string",
              "TownName": "string",
              "CountrySubDivision": "string",
              "Country": "string",
              "AddressLine": [
                "string"
              ]
            }
          },
          "CreditorAgent": {
            "SchemeName": [
              "UK.OBIE.BICFI"
            ],
            "Identification": "string",
            "Name": "string",
            "PostalAddress": {
              "AddressType": "Business",
              "Department": "string",
              "SubDepartment": "string",
              "StreetName": "string",
              "BuildingNumber": "string",
              "PostCode": "string",
              "TownName": "string",
              "CountrySubDivision": "string",
              "Country": "string",
              "AddressLine": [
                "string"
              ]
            }
          },
          "CreditorAccount": {
            "SchemeName": [
              "UK.OBIE.BBAN",
              "UK.OBIE.IBAN",
              "UK.OBIE.PAN",
              "UK.OBIE.Paym",
              "UK.OBIE.SortCodeAccountNumber"
            ],
            "Identification": "string",
            "Name": "string",
            "SecondaryIdentification": "string"
          },
          "RemittanceInformation": {
            "Unstructured": "string",
            "Reference": "string"
          },
          "SupplementaryData": {}
        },
        "Authorisation": {
          "AuthorisationType": "Any",
          "CompletionDateTime": "2019-07-28T07:45:47.510Z"
        }
      },
      "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "string",
        "MerchantCustomerIdentification": "string",
        "DeliveryAddress": {
          "AddressLine": [
            "string"
          ],
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": [
            "string"
          ],
          "Country": "string"
        }
      }
    }
  • Add all mandatory headers:
    • x-fapi-financial-id - The unique id of the ASPSP to which the request is issued. This id will be issued by the OBIE.
    • Authorization - An Authorisation Token as per https://tools.ietf.org/html/rfc6750. Enter the application access token, you generated from the above step.

    • x-idempotency-key - Every request will be processed only once per x-idempotency-key. The Idempotency key will be valid for 24 hours.
    • x-jws-signature - A detached JWS signature of the body of the payload.
  • A sample request follows the format given below.

    Code Block
    curl POST \
      https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-scheduled-payment-consents HTTP/1.1Authorization: Bearer <APPLICATION_ACCESS_TOKEN>
    x-idempotency-key: FRESCO.21302.GFX.20
    x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
    \
      -H 'x-fapi-financial-id: OB/2017/001
    x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT
    x-fapi-customer-ip-address: 104.25.212.99
    x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
     open-bank' \
      -H 'x-idempotency-key: 30479' \
      -H 'Authorization: Bearer <APPLICATION_ACCESS_TOKEN>' \
      -H 'Accept: application/json' \
      -H 'x-jws-signature: eyJhbGciOiJQUzI1NiIsImtpZCI6Imp5UlVjeXQxa1ZDbGNJdmxVbGNEdWtWWjN0VSIsImNyaXQiOlsiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIl0sImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IjoxNjAxOTYzNTYyLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiI6Im9wZW5iYW5raW5nLm9yZy51ayIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiQ049U0NtRXY5R1FlQnJuZFBaTlo1QVdObiwgT1U9MDAxNTgwMDAwMUhRUXJaQUFYLCBPPU9wZW5CYW5raW5nLCBDPUdCIn0..vvmPLpNegwIASwyZkGkC6rZKG124StNaB41B2V8PqCJ7nJir6IsOTxWkChskAzDS9jfdqEknBE-DYI1acH9yAX7DAmyGD4hsfN0RdEzU0JZVYOgEzQShygT2pAMaCpiW4dV6hvZ-fTCQZMkhM5ll5ps2l-Bzgj5tjwlOtXCW-Xh2xeIwyxkStEbqep2ekySSQUoiZhwvGoJCnQhs6hwpWn8EOs_Ex_q6cXN1bV5Q4Y3q_Vp-7U9IPIyq1d1JOM86SnpqyGld3WbcNMLCDa5rToPcNdPL3XeeA5rzMaDa9Rw66PefUbX2ESPbQC7Tsez0S2Pjcz4sXtlltLFSgBdDxA' \
      -H 'charset: UTF-8' \
      -H 'Content-Type: application/json
    Accept: application/json
     
    ; charset=UTF-8' \
      --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
    -d '{
      "Data": {
        "Permission":"Create",
        "Initiation": {
          "InstructionIdentification": "ACME412",
          "EndToEndIdentification": "FRESCO.21302.GFX.20",
          "RequestedExecutionDate": "2018-08-06T00:00:00+00:00",
          "InstructedAmount": {
            "Amount": {
               "Amount": "165.88",
               "Currency": "USD"
             }
          },
          "CurrencyOfTransfer":"USD",
          "CreditorAccount": {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "08080021325698",
            "Name": "ACME Inc",
            "SecondaryIdentification": "0002"
          },
          "RemittanceInformation": {
            "Reference": "FRESCO-101",
            "Unstructured": "Internal ops code 5120101"
          },
          "ExchangeRateInformation": {
            "UnitCurrency": "GBP",
            "RateType": "Actual"
          }
        }
      },
      "Risk": {
        "PaymentContextCode": "PartyToParty"
      }
    }'
  • The response will bear the ConsentId.

    Code Block
    HTTP/1.1 201 Created
    x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
    x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
    Content-Type: application/json
     
    {
        "Data": {
            "Permission": "Create",
            "ConsentId": "58923",
            "Status": "AwaitingAuthorisation",
            "CutOffDateTime": "2017-06-05T16:00:13+00:00",
            "CreationDateTime": "2017-06-05T15:15:13+00:00",
            "StatusUpdateDateTime": "2017-06-05T15:15:13+00:00",
            "Initiation": {
                "InstructionIdentification": "ACME412",
                "EndToEndIdentification": "FRESCO.21302.GFX.20",
                "RequestedExecutionDate": "2018-08-06T00:00:00+00:00",      
                "InstructedAmount": {
                    "Amount": {
                       "Amount": "165.88",
                       "Currency": "USD"
                     }
                  },
                "CurrencyOfTransfer":"USD",
                "CreditorAccount": {
                    "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                    "Identification": "08080021325698",
                    "Name": "ACME Inc",
                    "SecondaryIdentification": "0002"
                },
                "RemittanceInformation": {
                    "Reference": "FRESCO-101",
                    "Unstructured": "Internal ops code 5120101"
                },
                "ExchangeRateInformation": {
                    "UnitCurrency": "GBP",
                    "RateType": "Actual"
                }
            },
            "ExchangeRateInformation": {
                "UnitCurrency": "GBP",
                "ExchangeRate": "1.10",
                "RateType": "Actual",
                "ExpirationDateTime": "2017-06-05T15:45:13+00:00"
            }
        },
        "Risk": {
            "PaymentContextCode": "PartyToParty"
     
        },
        "Links": {
            "Self": "https://obank.com/open-banking/v3.1/pisp/international-scheduled-payment-consents/58923"
        },
        "Meta": {}
    }

GET /international-scheduled-payment-consents/{ConsentId}

A PISP is able to retrieve a payment consent resource that they have created to check its status. The PISP must have an access token issued by the ASPSP using a client credentials grant.

  • Add the mandatory headers.
    • ConsentId - The unique id of the consent which you want to retrieve.
    • x-fapi-financial-id - The unique id of the ASPSP to which the request is issued. This id will be issued by the OBIE.
    • Authorization - An Authorisation Token as per https://tools.ietf.org/html/rfc6750. Enter the application access token, you generated from the above step.
  • A sample request follows the format given below.Following are the sample request and response:

    Localtab Group
    Localtab
    titleRequest
    Code Block
    curl GET \
      https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-scheduled-payment-consents/
    <ConsentId> HTTP/1.1Authorization: Bearer <APPLICATION_ACCESS_TOKEN>
    <CONSENT_ID> \
      -H 'x-fapi-financial-id: 
    OB/2017/001 x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
    open-bank' \
      -H 'Authorization: Bearer <APPLICATION_ACCESS_TOKEN>' \
      -H 'Accept: application/json

Multiexcerpt include
MultiExcerptNameUserAccessToken
PageWithExcerptDomestic Payments v3.1.1

Step 13 - Invoke payment submission API

POST /international-scheduled-payments

Once the international-scheduled-payment-consent has been authorised by the PSU, the PISP can proceed to submit the international-scheduled-payment for processing. This request is an instruction to the ASPSP to begin the process of international scheduled payments. 

The PISP must ensure that the Initiation and Risk sections of the international scheduled payments match the corresponding Initiation and Risk sections of the international scheduled payments consent resource. Any operations on the international scheduled payments resource will not result in a status change for the international scheduled payments resource.

The response contains InternationalScheduledPaymentId along with the payment submission details. 

...

titleRequest Body

...

  • '
      -H 'charset: UTF-8' \
      -H 'Content-Type: application/json; charset=UTF-8' \
      --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
    Localtab
    titleResponse
    Code Block
    {
        "Meta": {
             
        },
        "

...

  • Risk": {
            "

...

  • PaymentContextCode": "

...

  • EcommerceGoods",
            "

...

  • DeliveryAddress":

...

  •  {
                "

...

  • StreetName": 

...

  • "Acacia Avenue",
            

...

  •     "CountrySubDivision": "Wessex",
       

...

  •          "

...

  • AddressLine": [
           

...

  •          "

...

  • Flat 7",
           

...

  •          "

...

  • Acacia Lodge"
            

...

  •     ],
        

...

  •         "BuildingNumber": "

...

  • 27",
            

...

  •     

...

  • "TownName": "Sparsholt",
         

...

  •        "

...

  • Country": "

...

  • UK",
                "

...

  • PostCode": "

...

  • GU31 2ZZ"

...

  • 
           

...

  •  },
            "

...

  • MerchantCategoryCode": "

...

  • 5967",
            "

...

  • MerchantCustomerIdentification": "

...

  • 053598653254"

...

  • 
        },
        "

...

  • Links": {
            "

...

  • Self": "

...

  • https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-scheduled-payment-consents/459af02c-cee5-486f-916b-0be6320f12ac"
        },
        "

...

  • Data": 

...

  • {
         

...

  •    

...

  • "

...

  • Status": 

...

  • "Authorised",
            "

...

  • StatusUpdateDateTime": "

...

  • 2020-10-06T05:54:06Z",
            "

...

  • SCASupportData": {
       

...

  •          "

...

  • RequestedSCAExemptionType": "

...

  • BillPayment",
                "

...

  • AppliedAuthenticationApproach": "

...

  • CA",
          

...

  •       

...

  • "

...

  • ReferencePaymentOrderId": 

...

  • "string"
            

...

  • },
            "CreationDateTime": 

...

  • "2020-10-06T05:52:43Z",
            "

...

  • Authorisation": {
            

...

  •     

...

  • "CompletionDateTime": "2020-10-11T05:52:37.236Z",
                "AuthorisationType": "

...

  • Any"
            

...

  • },
            "

...

  • Permission": "

...

  • Create",
            "

...

  • ConsentId": "

...

  • 459af02c-cee5-486f-916b-0be6320f12ac",
            "

...

  • ReadRefundAccount": "

...

  • Yes",
     

...

  •        "

...

  • Initiation": {
            

...

  •  

...

  •    "DebtorAccount": {
        

...

  •  

...

  •            "

...

  • SecondaryIdentification": "

...

  • 30080012343456",
                    "

...

  • SchemeName": "

...

  • UK.OBIE.SortCodeAccountNumber",
                    "

...

  • Identification": "

...

  • 30080012343456",
              

...

  •       "Name": "

...

  • Andrea Smith"

...

  • 
               

...

  •  },
                "

...

  • EndToEndIdentification": "

...

  • FRESCO.21302.GFX.20",
                "

...

  • CurrencyOfTransfer": "

...

  • USD",
                "

...

  • InstructionIdentification": "

...

  • ACME412",
                "

...

  • CreditorAccount": 

...

  • {
              

...

  •  

...

  •      "SecondaryIdentification": "0002",
          

...

  •           

...

  • "SchemeName": "UK.OBIE.SortCodeAccountNumber",
              

...

  •       

...

  • "Identification": "08080021325698",
          

...

  •  

...

  •          "

...

  • Name": 

...

  • "ACME Inc"
           

...

  •      },
       

...

  •          "

...

  • Purpose": "

...

  • 1234",
                "

...

  • ChargeBearer": "

...

  • BorneByCreditor",

...

  • 
     

...

  •  

...

  •           

...

  • "

...

  • InstructionPriority": "

...

  • Normal",
                "

...

  • RequestedExecutionDateTime": "

...

  • 2020-10-11T05:52:37.102Z",
                "

...

  • LocalInstrument": "

...

  • UK.OBIE.BACS",
                "

...

  • RemittanceInformation": 

...

  • {
        

...

  •  

...

  •            "

...

  • Unstructured": "

...

  • Internal ops code 5120101",
         

...

  •            "

...

  • Reference": "

...

  • FRESCO-101"

...

  • 
               

...

  •  },
                "

...

  • ExchangeRateInformation": 

...

  • {
               

...

  •      "ExchangeRate": 1.34,
        

...

  •          

...

  •    

...

  • "RateType": "Agreed",
          

...

  •  

...

  •          "

...

  • UnitCurrency": 

...

  • "GBP",
                    

...

  • "ContractIdentification": "1234"
                

...

  • },
                "

...

  • Creditor": {
             

...

  •        "PostalAddress": {
      

...

  •          

...

  •          "

...

  • StreetName": "

...

  • Acacia Avenue",
             

...

  •            "

...

  • CountrySubDivision": "

...

  • Wessex",
          

...

  •               "

...

  • Department": 

...

  • "department1",
              

...

  •  

...

  •          "

...

  • AddressLine": 

...

  • [
          

...

  •        

...

  •      

...

  •    

...

  •    "

...

  • Flat 7",
          

...

  •  

...

  •      

...

  •  

...

  •      

...

  •  

...

  •      "

...

  • Acacia Lodge"
             

...

  •  

...

  •          

...

  •  ],
         

...

  •        

...

  •  

...

  •        "BuildingNumber": "

...

  • 27",
          

...

  •  

...

  •        

...

  •  

...

  •      

...

  • "

...

  • TownName": 

...

  • "Sparsholt",
            

...

  •       

...

  •       

...

  • "Country": "

...

  • UK",
           

...

  •    

...

  •  

...

titleResponse Body

...

  •    

...

  •  

...

  •      "

...

  • SubDepartment": "

...

  • sub dept",
            

...

  •  

...

  •      

...

  •  

...

  •      "

...

  • AddressType": "

...

  • Correspondence",
        

...

  •           

...

  •  

...

  •      "

...

  • PostCode": "

...

  • GU31 2ZZ"
          

...

  •  

...

  •        

...

  •   },
          

...

  •  

...

  •          "

...

  • Name": 

...

  • "ACME Inc"
                

...

  • },
              

...

  •   "InstructedAmount": {
             

...

  •        

...

  • "Amount": 

...

  • "30.80",
                

...

  •     "Currency": "

...

  • GBP"
            

...

  •     

...

  • }
        

...

  •     }

Multiexcerpt include
MultiExcerptNameUserAccessToken
PageWithExcerptDomestic Payments v3.1.1

Step 13 - Invoke payment submission API

POST /international-scheduled-payments

Once the international-scheduled-payment-consent has been authorised by the PSU, the PISP can proceed to submit the international-scheduled-payment for processing. This request is an instruction to the ASPSP to begin the process of international scheduled payments. 

The PISP must ensure that the Initiation and Risk sections of the international scheduled payments match the corresponding Initiation and Risk sections of the international scheduled payments consent resource. Any operations on the international scheduled payments resource will not result in a status change for the international scheduled payments resource.

The response contains InternationalScheduledPaymentId along with the payment submission details. 


Localtab Group
Localtab
titleRequest
Code Block
curl POST \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-scheduled-payments \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-idempotency-key: 944277' \
  -H 'Authorization: Bearer <USER_ACCESS_TOKEN>' \
  -H 'Accept: application/json' \
  -H 'x-jws-signature: eyJhbGciOiJQUzI1NiIsImtpZCI6Imp5UlVjeXQxa1ZDbGNJdmxVbGNEdWtWWjN0VSIsImNyaXQiOlsiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIl0sImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IjoxNjAxOTYzODIzLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiI6Im9wZW5iYW5raW5nLm9yZy51ayIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiQ049U0NtRXY5R1FlQnJuZFBaTlo1QVdObiwgT1U9MDAxNTgwMDAwMUhRUXJaQUFYLCBPPU9wZW5CYW5raW5nLCBDPUdCIn0..dPhjNV5qxOXtZWns_inuyMYg9O0nnVCs4jyQ9sr_7wTiIBUJRgzCtEzzxl2Ew8v56ORJiWq5VUxzyRba_XokgTCwCECZbJhMj3-XSK8dZNUCvK0mbQ7LJ3-z3juJReOQD4dO5Xj_ZzxF7QiqgzBRC6j2ltpWcQ6ZQ6zybzxZx4ciYQN6vkJTs1ws6m7u2idk8e3SPdCPgN_eJWzAkdyJxC7q5mdpnV1ujROAyQaZiYKHQdOEwPCglhYCCDRbV5fxr7HpBV05Ljm6jU-aDnAoBTMvT9UJ258HUcuvEpULs9_U0KMAnMKPyhBV9YEFHsKho0JJHf9-QPaWaO5zfVIu0g' \
  -H 'charset: UTF-8' \
  -H 'Content-Type: application/json; charset=UTF-8' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
 -d '{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": [
        "UK.OBIE.SEPAInstantCreditTransferBACS",
        "UK.OBIE.SWIFTBalanceTransfer",
        "UK.OBIE.Target2CHAPS",
      ],  "UK.OBIE.Euro1",
       "InstructionPriority": "NormalUK.OBIE.FPS",
      "Purpose":  "stringUK.OBIE.Link",
       "ChargeBearer": "BorneByCreditorUK.OBIE.MoneyTransfer",
      "RequestedExecutionDateTime": "2019-07-28T07:56:14.278Z",  "UK.OBIE.Paym",
       "CurrencyOfTransfer": "stringUK.OBIE.SEPACreditTransfer",
      "InstructedAmount": {  "UK.OBIE.SEPAInstantCreditTransfer",
        "Amount": "string"UK.OBIE.SWIFT",
        "CurrencyUK.OBIE.Target2":
"string"       }],
      "ExchangeRateInformationInstructionPriority": {
 "Normal",
      "UnitCurrencyPurpose": "string",
        "ExchangeRateChargeBearer": 0"BorneByCreditor",
        "RateTypeRequestedExecutionDateTime": "Actual2019-07-28T07:56:14.202Z",
        "ContractIdentificationCurrencyOfTransfer": "string"
      },
      "DebtorAccountInstructedAmount": {
        "SchemeNameAmount": ["string",
         "Currency": "UK.OBIE.BBAN",string"
      },
    "UK.OBIE.IBAN",
          "UK.OBIE.PAN",
"ExchangeRateInformation": {
         "UK.OBIE.Paym",
          "UK.OBIE.SortCodeAccountNumber"
        ]UnitCurrency": "string",
        "IdentificationExchangeRate": "string"0,
        "NameRateType": "stringActual",
        "SecondaryIdentificationContractIdentification": "string"
      },
      "CreditorDebtorAccount": {
        "NameSchemeName": "string", [
          "PostalAddress": {UK.OBIE.BBAN",
          "AddressType": "Business"UK.OBIE.IBAN",
          "Department": "stringUK.OBIE.PAN",
          "SubDepartment": "string"UK.OBIE.Paym",
          "StreetName": "string",
 UK.OBIE.SortCodeAccountNumber"
        ],
        "BuildingNumberIdentification": "string",
          "PostCodeName": "string",
          "TownNameSecondaryIdentification": "string",
      },
      "CountrySubDivisionCreditor": "string",
 {
        "CountryName": "string",

         "AddressLinePostalAddress": [{
           "AddressType": "stringBusiness",
          ]"Department": "string",
        }  "SubDepartment": "string",
   },       "CreditorAgentStreetName": {
        "SchemeName": ["string",
          "BuildingNumber": "UK.OBIE.BICFIstring",
        ],
        "IdentificationPostCode": "string",
          "NameTownName": "string",
          "PostalAddressCountrySubDivision": {"string",
          "AddressTypeCountry": "Businessstring",
          "DepartmentAddressLine": "string",[
           "SubDepartment": "string",
          "StreetName": "string",]
        }
  "BuildingNumber": "string",    },
      "PostCodeCreditorAgent": "string",{
          "TownNameSchemeName": "string",[
          "CountrySubDivisionUK.OBIE.BICFI"
        ],
        "Identification": "string",
 
        "CountryName": "string",
          "AddressLinePostalAddress": [{
           "AddressType": "stringBusiness",
          ]"Department": "string",
        }  "SubDepartment": "string",
   },       "CreditorAccountStreetName": {"string",
          "SchemeNameBuildingNumber": "string",
[          "PostCode": "UK.OBIE.BBANstring",
          "UK.OBIE.IBAN"TownName": "string",
          "UK.OBIE.PANCountrySubDivision": "string",
          "UK.OBIE.PaymCountry": "string",
          "UK.OBIE.SortCodeAccountNumberAddressLine": [
       ],         "Identification": "string",
        "Name": "string", ]
       "SecondaryIdentification": "string" }
      },
      "RemittanceInformationCreditorAccount": {
        "UnstructuredSchemeName": [
"string",         "Reference": "string"
UK.OBIE.BBAN",
     },       "SupplementaryData": {}"UK.OBIE.IBAN",
     },     "MultiAuthorisation": {UK.OBIE.PAN",
         "Status": "AuthorisedUK.OBIE.Paym",
      "NumberRequired": 0    "UK.OBIE.SortCodeAccountNumber"
        ],
        "NumberReceivedIdentification": 0"string",
        "LastUpdateDateTimeName": "2019-07-28T07:56:14.278Zstring",
        "ExpirationDateTimeSecondaryIdentification": "2019-07-28T07:56:14.278Z"string"
      },
  },    "LinksRemittanceInformation": {
        "SelfUnstructured": "string",
        "FirstReference": "string",
     "Prev": "string" },
    "Next  "SupplementaryData": {}
    }
  },
  "Risk": {
    "PaymentContextCode": "stringBillPayment",
    "LastMerchantCategoryCode": "string",
    }"MerchantCustomerIdentification": "string",
    "MetaDeliveryAddress": {
      "TotalPagesAddressLine": 0, [
        "string"
      ],
      "FirstAvailableDateTimeStreetName": "2019-07-28T07:56:14.278Zstring",
      "LastAvailableDateTimeBuildingNumber": "2019-07-28T07:56:14.278Z""string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

Following API functionalities are available in the Payment Initiation API.

Table of Contents
minLevel4

GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation

The API endpoint allows the PISP to ask an ASPSP to confirm funds on an international-scheduled-payment-consent resource, where the payment is for immediate debit.

An ASPSP can only respond to a funds confirmation request if the international-scheduled-payment-consent resource has an Authorised status. Confirmation of funds requests do not affect the status of the international-scheduled-payment-consent resource.

Localtab Group
Localtab
titleRequest
Code Block
GET /international-scheduled-payment-consents/<ConsentId>/funds-confirmation HTTP/1.1
Authorization: Bearer <USER_ACCESS_TOKEN>
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
Localtab
titleResponse
Code Block
HTTP/1.1 200 OK

x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
    "Data": {
        "FundsAvailableResult": {
            "FundsAvailableDateTime": "2017-06-05T15:15:23+00:00",
            "FundsAvailable": true
        }
    },
    "Links": {
        "Self": "https://obank.com/open-banking/v3.1/pisp/domestic-payment-consents/58923/funds-confirmation"
    },
    "Meta": {}
}

GET /international-scheduled-payments/{InternationalScheduledPaymentId}

The PISP retrieves the internationalscheduled payments resource to check its status.

Localtab Group Localtab
titleRequest
Code BlockGET /international-scheduled-payments/<InternationalScheduledPaymentId> HTTP/1.1 Authorization: Bearer <USER_ACCESS_TOKEN> x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json
'



Localtab
titleResponse
Code Block
{
  "Data": {
    "InternationalScheduledPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2019-07-28T07:56:14.278Z",
    "Status": "InitiationCompleted",
    "StatusUpdateDateTime": "2019-07-28T07:56:14.278Z",
    "ExpectedExecutionDateTime": "2019-07-28T07:56:14.278Z",
    "ExpectedSettlementDateTime": "2019-07-28T07:56:14.278Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": [
          "UK.OBIE.CHAPSOut",
          "UK.OBIE.BalanceTransferOut",
          "UK.OBIE.MoneyTransferOut"
        ],
        "Amount": {
          "Amount": {
            "Amount": "string",
            "Currency": "string"
          },
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2019-07-28T07:56:14.278Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": [
        "UK.OBIE.BACS",
        "UK.OBIE.BalanceTransfer",
        "UK.OBIE.CHAPS",
        "UK.OBIE.Euro1",
        "UK.OBIE.FPS",
        "UK.OBIE.Link",
        "UK.OBIE.MoneyTransfer",
        "UK.OBIE.Paym",
        "UK.OBIE.SEPACreditTransfer",
        "UK.OBIE.SEPAInstantCreditTransfer",
        "UK.OBIE.SWIFT",
        "UK.OBIE.Target2"
      ],
      "InstructionPriority": "Normal",
      "Purpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2019-07-28T07:56:14.278Z",
      "CurrencyOfTransfer": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": [
          "UK.OBIE.BBAN",
          "UK.OBIE.IBAN",
          "UK.OBIE.PAN",
          "UK.OBIE.Paym",
          "UK.OBIE.SortCodeAccountNumber"
        ],
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "Creditor": {
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": [
          "UK.OBIE.BICFI"
        ],
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": [
          "UK.OBIE.BBAN",
          "UK.OBIE.IBAN",
          "UK.OBIE.PAN",
          "UK.OBIE.Paym",
          "UK.OBIE.SortCodeAccountNumber"
        ],
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "MultiAuthorisation": {
      "Status": "Authorised",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2019-07-28T07:56:14.278Z",
      "ExpirationDateTime": "2019-07-28T07:56:14.278Z"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2019-07-28T07:56:14.278Z",
    "LastAvailableDateTime": "2019-07-28T07:56:14.278Z"
  }
}

GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation

The API endpoint allows the PISP to ask an ASPSP to confirm funds on an international-scheduled-payment-consent resource, where the payment is for immediate debit.

An ASPSP can only respond to a funds confirmation request if the international-scheduled-payment-consent resource has an Authorised status. Confirmation of funds requests do not affect the status of the international-scheduled-payment-consent resource.

Localtab Group
Localtab
titleRequest
Code Block
curl GET \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-scheduled-payment-consents/<CONSENT_ID>/funds-confirmation \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'Authorization: Bearer <USER_ACCESS_TOKEN>' \
  -H 'Accept: application/json' \
  -H 'charset: UTF-8' \
  -H 'Content-Type= application/json; charset=UTF-8' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
Localtab
titleResponse
Code Block
{
    "Data": {
        "FundsAvailableResult": {
            "FundsAvailableDateTime": "2017-06-05T15:15:23+00:00",
            "FundsAvailable": true
        }
    },
    "Links": {
        "Self": "https://obank.com/open-banking/v3.1/pisp/domestic-payment-consents/58923/funds-confirmation"
    },
    "Meta": {}
}

GET /international-scheduled-payments/{InternationalScheduledPaymentId}

The PISP retrieves the internationalscheduled payments resource to check its status.

Localtab Group
Localtab
titleRequest
Code Block
curl GET \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-scheduled-payments/<INTERNATIONAL_SCHEDULED_PAYMENT_ID> \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'Authorization: Bearer <USER_ACCESS_TOKEN>' \
  -H 'Accept: application/json' \
  -H 'charset: UTF-8' \
  -H 'Content-Type: application/json; charset=UTF-8' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
Localtab
titleResponse
Code Block
{
    "Meta": {
         
    },
    "Links": {
        "Self": "/international-scheduled-payments/459af02c-cee5-486f-916b-0be6320f12ac-52"
    },
    "Data": {
        "Status": "InitiationCompleted",
        "StatusUpdateDateTime": "2020-10-06T05:57:03Z",
        "CreationDateTime": "2020-10-06T05:57:03Z",
        "InternationalScheduledPaymentId": "459af02c-cee5-486f-916b-0be6320f12ac-52",
        "ConsentId": "459af02c-cee5-486f-916b-0be6320f12ac",
        "Initiation": {
            "DebtorAccount": {
                "SecondaryIdentification": "30080012343456",
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": "30080012343456",
                "Name": "Andrea Smith"
            },
            "EndToEndIdentification": "FRESCO.21302.GFX.20",
            "InstructionIdentification": "ACME412",
            "CurrencyOfTransfer": "USD",
            "CreditorAccount": {
                "SecondaryIdentification": "0002",
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": "08080021325698",
                "Name": "ACME Inc"
            },
            "Purpose": "1234",
            "ChargeBearer": "BorneByCreditor",
            "InstructionPriority": "Normal",
            "RequestedExecutionDateTime": "2020-10-11T05:52:37.102Z",
            "LocalInstrument": "UK.OBIE.BACS",
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120101",
                "Reference": "FRESCO-101"
            },
            "ExchangeRateInformation": {
                "ExchangeRate": 1.34,
                "RateType": "Agreed",
                "UnitCurrency": "GBP",
                "ContractIdentification": "1234"
            },
            "Creditor": {
                "PostalAddress": {
                    "StreetName": "Acacia Avenue",
                    "CountrySubDivision": "Wessex",
                    "Department": "department1",
                    "AddressLine": [
                        "Flat 7",
                        "Acacia Lodge"
                    ],
                    "BuildingNumber": "27",
                    "TownName": "Sparsholt",
                    "Country": "UK",
                    "SubDepartment": "sub dept",
                    "AddressType": "Correspondence",
                    "PostCode": "GU31 2ZZ"
                },
                "Name": "ACME Inc"
            },
            "InstructedAmount": {
                "Amount": "30.80",
                "Currency": "GBP"
            }
        }
    }
}