POST /domestic-payment-consentsThis endpoint allows the PISP to ask an ASPSP to create a new domestic-payment-consent resource. The ASPSP creates the domestic-payment-consent resource and responds with a unique ConsentId to refer to the resource. Use the following format in the request body. | Code Block |
|---|
{
"Data": {
"Initiation": {
"InstructionIdentification": "ANSM023",
"EndToEndIdentification": "FRESCO.21302.GFX.37",
"InstructedAmount": {
"Amount": "20.00",
"Currency": "GBP"
},
"DebtorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "11280001234567",
"Name": "Andrea Smith"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "Bob Clements"
},
"RemittanceInformation": {
"Reference": "FRESCO-037",
"Unstructured": "Internal ops code 5120103"
}
}
},
"Risk": {
"PaymentContextCode": "PartyToParty"
}
} |
- Add all mandatory headers:
A sample request follows the format given below. | Code Block |
|---|
curl POST /
https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/domestic-payment-consents \
-H 'Authorization: Bearer <APPLICATION_ACCESS_TOKEN>' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-H 'x-fapi-financial-id: open-bank' \
-H 'x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
{ "--cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
-d '{
"Data": {
"Initiation": {
"InstructionIdentification": "ANSM023",
"EndToEndIdentification": "FRESCO.21302.GFX.37",
"InstructedAmount": {
"Amount": "20.00",
"Currency": "GBP"
},
"DebtorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "11280001234567",
"Name": "Andrea Smith"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "Bob Clements"
},
"RemittanceInformation": {
"Reference": "FRESCO-037",
"Unstructured": "Internal ops code 5120103"
}
}
},
"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": {
"ConsentId": "7290",
"Status": "AwaitingAuthorisation",
"CreationDateTime": "2017-06-05T15:15:13+00:00",
"StatusUpdateDateTime": "2017-06-05T15:15:13+00:00",
"Initiation": {
"InstructionIdentification": "ANSM023",
"EndToEndIdentification": "FRESCO.21302.GFX.37",
"InstructedAmount": {
"Amount": "20.00",
"Currency": "GBP"
},
"DebtorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "11280001234567",
"Name": "Andrea Smith"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "Bob Clements"
},
"RemittanceInformation": {
"Reference": "FRESCO-037",
"Unstructured": "Internal ops code 5120103"
}
}
},
"Risk": {
"PaymentContextCode": "PartyToParty"
},
"Links": {
"Self": "https://obank.com/open-banking/v3.1/pisp/domestic-payment-consents/7290"
},
"Meta": {}
} |
GET /domestic-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.
|