Domestic payments
On this page:
POST[base]/domestic-payment-consents |
|
GET[base]/domestic-payment-consents/{consentId} |
|
GET[base]/domestic-payment-consents/{consentId}/funds-confirmation |
|
POST[base]/domestic-payments |
|
GET[base]/domestic-payments/{domesticPaymentId} |
Add a domestic payment consent
Use this method to authorize the PSU access to payment information.
By calling this request, the PISP sends a copy of the consent to the ASPSP to authorize the PSU.
The ASPSP creates a new domestic-payment-consent
resource and responds with a unique consentId to refer to the resource.
Request
Header parameters:
- Authorization
The authorization token as per https://tools.ietf.org/html/rfc6750 .
- x-idempotency-key required
The unique key that the resource server uses to recognize subsequent retries of the same request.
Every request is only processed once as per
x-idempotency-key
which is valid for 24 hours.- x-jws-signature required
The detached JSON WEB signature (JWS) of the payload body.
- x-fapi-financial-id required
The unique identifier of the ASPSP issued by the Open Banking system.
- x-fapi-customer-last-logged-time
The date and time when the PSU has last logged in the system using a TPP application.
- x-fapi-customer-ip-address
The IP address of the PSU who has logged in the system using a TPP application.
- x-fapi-interaction-id
The unique identifier of the initiating party (as per RFC 4122 UID) used as a correlation identifier.
- x-customer-user-agent
The user-agent used by the PSU.
Body
- Data object required
This object provides the following data:
Expand fields- InstructionIdentification string
The unique identification assigned by an instructing party to identify the instruction.
- EndToEndIdentification string
The unique identification assigned by the initiating party to identify the transaction. The Faster Payments Scheme can only access
31
characters for theEndToEndIdentification
field.- LocalInstrument string
The local clearing option specifying the service.
Example:
"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"
- InstructedAmount object
This object provides the following data:
Expand fields- Amount string
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. This amount has to be transported unchanged through the transaction chain.
- Currency string
The currency of a transaction as per ISO 4217.
- DebtorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a debtor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a creditor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorPostalAddress object
This object provides the following data:
Expand fields- AddressType string
The address type of an agent. Possible values:
Business
Correspondence
DeliveryTo
MailTo
POBox
Postal
Residential
Statement
- Department string
The department of the building of an agent.
- SubDepartment string
The subdepartment of the building of an agent.
- StreetName string
The name of the street of an agent.
- BuildingNumber string
The number of the building of an agent.
- PostCode string
The postal code of an agent.
- TownName string
The name the town of an agent.
- CountrySubDivision string
The subdivision of the country of an agent.
- Country string
The country of an agent.
- AddressLine array
The address line of an agent.
- RemittanceInformation object
This object provides the following data:
Expand fields- Unstructured string
The information supplied to enable the matching and reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts receivable system, in an unstructured form.
- Reference string
The unique reference to the payment transaction assigned by the creditor.
If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
The Faster Payments Scheme can only accept
18
characters for theReferenceInformation field
.
- SupplementaryData object
The additional information about a transaction.
- Authorization object
This object provides the following data:
Expand fields- AuthorizationType string
The authorization type. Possible values:
Any
Single
- CompletionDateTime string
The date and time when an authorization was completed.
- Risk object
The parameters of the Risk section are sent to the ASPSP by the initiating party.
This information is used to specify additional details for the payments risk scoring.
This object provides the following data:
Expand fields- PaymentContextCode string
The payment context specification. Possible values:
BillPayment
EcommerceGoods
EcommerceServices
Other
PartyToParty
- MerchantCategoryCode string
The category code as per ISO 18245, related to the type of services or goods the merchant provides for the transaction.
- MerchantCustomerIdentification string
The unique customer identifier of the merchant.
- DeliveryAddress object
This object provides the following data:
Expand fields- AddressLine array
The address line for the delivery.
- StreetName string
The name of the street.
- BuildingNumber string
The number of the building.
- PostCode string
The postal code.
- TownName string
The name the town.
- CountrySubDivision string
The subdivision of the country.
- Country string
The name of the country.
POST[base]/domestic-payment-consents
{
"Data": {
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"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"
],
"InstructedAmount": {
"Amount": "165.88",
"Currency": "GBP"
},
"DebtorAccount": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "08080021325698",
"Name": "ACME Inc",
"SecondaryIdentification": "0002"
},
"CreditorAccount": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "08080021325698",
"Name": "ACME Inc",
"SecondaryIdentification": "0002"
},
"CreditorPostalAddress": {
"AddressType": "Business",
"Department": "Wessex",
"SubDepartment": "Wessex",
"StreetName": "Acacia Lodge",
"BuildingNumber": "235",
"PostCode": "GU31 2ZZ",
"TownName": "Sparsholt",
"CountrySubDivision": "Wessex",
"Country": "UK",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
},
"SupplementaryData": {}
},
"Authorisation": {
"AuthorisationType": "Any",
"CompletionDateTime": "2023-01-17T05:18:57.668Z"
}
},
"Risk": {
"PaymentContextCode": "BillPayment",
"MerchantCategoryCode": "stri",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"StreetName": "Acacia Avenue",
"BuildingNumber": "27",
"PostCode": "GU31 2ZZ",
"TownName": "Sparsholt",
"CountrySubDivision": [
"Wessex"
],
"Country": "UK"
}
}
}
Response
Body:
- Data object
This object provides the following data:
Expand fields- ConsentId string
The consent identifier.
- CreationDateTime string
The date and time when a consent was created.
- Status string
The consent status. Possible values:
Authorized
AwaitingAuthorization
Consumed
Rejected
- StatusUpdateDateTime string
The date and time when the status of a consent was updated.
- CutOffDateTime string
The specified cut-off date and time of a payment consent.
- ExpectedExecutionDateTime string
The date and time when a payment transaction is expected to be executed.
- ExpectedSettlementDateTime string
The date and time of a payment transaction settlement.
- charges array
This array provides the following data:
Expand fields- ChargeBearer string
The party which bears the charges associated with the processing of a payment transaction. Possible values:
BorneByCreditor
BorneByDebtor
FollowingServiceLevel
Shared
- Type string
The charge type, in a coded form.
Example:
"UK.OBIE.CHAPSOut"
"UK.OBIE.BalanceTransferOut"
"UK.OBIE.MoneyTransferOut"
- Amount string
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. This amount has to be transported unchanged through the transaction chain.
- Currency string
The currency of a transaction as per ISO 4217.
- Initiation object
This object provides the following data:
Expand fields- InstructionIdentification string
The unique identification assigned by an instructing party to identify the instruction.
- EndToEndIdentification string
The unique identification assigned by the initiating party to identify the transaction.
The Faster Payments Scheme can only access
31
characters for theEndToEndIdentification
field.- LocalInstrument string
The local clearing option specifying the service.
Example:
"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"
- InstructedAmount object
This object provides the following data:
Expand fields- Amount string
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. This amount has to be transported unchanged through the transaction chain.
- Currency string
The currency of a transaction as per ISO 4217.
- DebtorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a debtor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a creditor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorPostalAddress object
This object provides the following data:
Expand fields- AddressType string
The address type of an agent. Possible values:
Business
Correspondence
DeliveryTo
MailTo
POBox
Postal
Residential
Statement
- Department string
The department of the building of an agent.
- SubDepartment string
The subdepartment of the building of an agent.
- StreetName string
The name of the street of an agent.
- BuildingNumber string
The number of the building of an agent.
- PostCode string
The postal code of an agent.
- TownName string
The name the town of an agent.
- CountrySubDivision string
The subdivision of the country of an agent.
- Country string
The country of an agent.
- AddressLine array
The address line of an agent.
- RemittanceInformation object
This object provides the following data:
Expand fields- Unstructured string
The information supplied to enable the matching and reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts receivable system, in an unstructured form.
- Reference string
The unique reference to the payment transaction assigned by the creditor.
If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
The Faster Payments Scheme can only accept
18
characters for theReferenceInformation field
.
- SupplementaryData object
The additional information about a transaction.
- Authorization object
This object provides the following data:
Expand fields- AuthorizationType string
The authorization type. Possible values:
Any
Single
- CompletionDateTime string
The date and time when an authorization was completed.
- Risk object
The parameters of the Risk section are sent to the ASPSP by the initiating party.
This information is used to specify additional details for the payments risk scoring.
This object provides the following data:
Expand fields- PaymentContextCode string
The payment context specification. Possible values:
BillPayment
EcommerceGoods
EcommerceServices
Other
PartyToParty
- MerchantCategoryCode string
The category code as per ISO 18245, related to the type of services or goods the merchant provides for the transaction.
- MerchantCustomerIdentification string
The unique customer identifier of the merchant.
- DeliveryAddress object
This object provides the following data:
Expand fields- AddressLine array
The address line for the delivery.
- StreetName string
The name of the street.
- BuildingNumber string
The number of the building.
- PostCode string
The postal code.
- TownName string
The name the town.
- CountrySubDivision string
The subdivision of the country.
- Country string
The name of the country.
HTTP status codes:
The eqwire API uses standard HTTP response codes to indicate the success or failure of a request.
To view a full list of valid response codes, refer to HTTP response codes.
{
"Data": {
"ConsentId": "string",
"CreationDateTime": "2023-01-18T10:19:00.062Z",
"Status": "Authorised",
"StatusUpdateDateTime": "2023-01-18T10:19:00.062Z",
"CutOffDateTime": "2023-01-18T10:19:00.062Z",
"ExpectedExecutionDateTime": "2023-01-18T10:19:00.062Z",
"ExpectedSettlementDateTime": "2023-01-18T10:19:00.062Z",
"Charges": [
{
"ChargeBearer": "BorneByCreditor",
"Type": [
"UK.OBIE.CHAPSOut",
"UK.OBIE.BalanceTransferOut",
"UK.OBIE.MoneyTransferOut"
],
"Amount": {
"Amount": "5",
"Currency": "USD"
}
}
],
"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"
],
"InstructedAmount": {
"Amount": "5",
"Currency": "USD"
},
"DebtorAccount": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "Debtor's financial institution",
"Name": "Debtor account's name",
"SecondaryIdentification": "Account's secondary identification"
},
"CreditorAccount": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "Creditor's financial institution",
"Name": "Creditor account's name",
"SecondaryIdentification": "Account's secondary identification"
},
"CreditorPostalAddress": {
"AddressType": "Business",
"Department": "Department",
"SubDepartment": "Sub-department",
"StreetName": "Street name",
"BuildingNumber": "Building number",
"PostCode": "Postal code",
"TownName": "Town",
"CountrySubDivision": "Country sub-division",
"Country": "Country",
"AddressLine": [
"Address line"
]
},
"RemittanceInformation": {
"Unstructured": "Unstructured information",
"Reference": "Payment transaction reference"
},
"SupplementaryData": {}
},
"Authorisation": {
"AuthorisationType": "Any",
"CompletionDateTime": "2023-01-18T10:19:00.063Z"
}
},
"Risk": {
"PaymentContextCode": "BillPayment",
"MerchantCategoryCode": "Category as per ISO 18245",
"MerchantCustomerIdentification": "Merchant's customer ID",
"DeliveryAddress": {
"AddressLine": [
"Address line"
],
"StreetName": "Street name",
"BuildingNumber": "Building number",
"PostCode": "Postal code",
"TownName": "Town",
"CountrySubDivision": [
"Country sub-division"
],
"Country": "Country"
}
},
"Links": {
"Self": "0",
"First": "0",
"Prev": "0",
"Next": "0",
"Last": "0"
},
"Meta": {
"TotalPages": 0,
"FirstAvailableDateTime": "2023-01-18T10:19:00.063Z",
"LastAvailableDateTime": "2023-01-18T10:19:00.063Z"
}
}
Get domestic payment consent details
Use this method to obtain detailed information about a specified domestic payment consent.
Request
Header parameters:
- Authorization
The authorization token as per https://tools.ietf.org/html/rfc6750.
- x-fapi-financial-id required
The unique identifier of the ASPSP issued by the Open Banking system.
- x-fapi-customer-last-logged-time
The date and time when the PSU has last logged in system using a TPP application.
- x-fapi-customer-ip-address
The IP address of the PSU who has logged in system using a TPP application.
- x-fapi-interaction-id
The unique identifier of the initiating party (as per RFC4122 UID) used as a correlation identifier.
- x-customer-user-agent
The user-agent used by the PSU.
Path parameters:
- ConsentId required
The consent identifier.
GET[base]/domestic-payment-consents/{consentId}
GET /domestic-payment-consents/consent-id-example HTTP/1.1
Authorization: Bearer <token>
x-fapi-financial-id: b621cec4-e775-49ab-980a-1900c6a09620
x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
Response
Body:
- Data object
This object provides the following data:
Expand fields- ConsentId string
The consent identifier.
- CreationDateTime string
The date and time when a consent was created.
- Status string
The consent status. Possible values:
Authorized
AwaitingAuthorization
Consumed
Rejected
- StatusUpdateDateTime string
The date and time when the status of a consent was updated.
- CutOffDateTime string
The specified cut-off date and time of a payment consent.
- ExpectedExecutionDateTime string
The date and time when a payment transaction is expected to be executed.
- ExpectedSettlementDateTime string
The date and time of a payment transaction settlement.
- charges array
This array provides the following data:
Expand fields- ChargeBearer string
The party which bears the charges associated with the processing of a payment transaction. Possible values:
BorneByCreditor
BorneByDebtor
FollowingServiceLevel
Shared
- Type string
The charge type, in a coded form.
Example:
"UK.OBIE.CHAPSOut"
"UK.OBIE.BalanceTransferOut"
"UK.OBIE.MoneyTransferOut"
- Amount string
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. This amount has to be transported unchanged through the transaction chain.
- Currency string
The currency of a transaction as per ISO 4217.
- Initiation object
This object provides the following data:
Expand fields- InstructionIdentification string
The unique identification assigned by an instructing party to identify the instruction.
- EndToEndIdentification string
The unique identification assigned by the initiating party to identify the transaction.
The Faster Payments Scheme can only access
31
characters for theEndToEndIdentification
field.- LocalInstrument string
The local clearing option specifying the service.
Example:
"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"
- InstructedAmount object
This object provides the following data:
Expand fields- Amount string
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. This amount has to be transported unchanged through the transaction chain.
- Currency string
The currency of a transaction as per ISO 4217.
- DebtorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a debtor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a creditor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorPostalAddress object
This object provides the following data:
Expand fields- AddressType string
The address type of an agent. Possible values:
Business
Correspondence
DeliveryTo
MailTo
POBox
Postal
Residential
Statement
- Department string
The department of the building of an agent.
- SubDepartment string
The subdepartment of the building of an agent.
- StreetName string
The name of the street of an agent.
- BuildingNumber string
The number of the building of an agent.
- PostCode string
The postal code of an agent.
- TownName string
The name the town of an agent.
- CountrySubDivision string
The subdivision of the country of an agent.
- Country string
The country of an agent.
- AddressLine array
The address line of an agent.
- RemittanceInformation object
This object provides the following data:
Expand fields- Unstructured string
The information supplied to enable the matching and reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts receivable system, in an unstructured form.
- Reference string
The unique reference to the payment transaction assigned by the creditor.
If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
The Faster Payments Scheme can only accept
18
characters for theReferenceInformation field
.
- SupplementaryData object
The additional information about a transaction.
- Authorization object
This object provides the following data:
Expand fields- AuthorizationType string
The authorization type. Possible values:
Any
Single
- CompletionDateTime string
The date and time when an authorization was completed.
- Risk object
The parameters of the Risk section are sent to the ASPSP by the initiating party.
This information is used to specify additional details for тхе payments risk scoring.
This object provides the following data:
Expand fields- PaymentContextCode string
The payment context specification. Possible values:
BillPayment
EcommerceGoods
EcommerceServices
Other
PartyToParty
- MerchantCategoryCode string
The category code as per ISO 18245, related to the type of services or goods the merchant provides for the transaction.
- MerchantCustomerIdentification string
The unique customer identifier of the merchant.
- DeliveryAddress object
This object provides the following data:
Expand fields- AddressLine array
The address line for the delivery.
- StreetName string
The name of the street.
- BuildingNumber string
The number of the building.
- PostCode string
The postal code.
- TownName string
The name the town.
- CountrySubDivision string
The subdivision of the country.
- Country string
The name of the country.
HTTP status codes:
The eqwire API uses standard HTTP response codes to indicate the success or failure of a request.
To view a full list of valid response codes, refer to HTTP response codes.
{
"Data": {
"ConsentId": "58923",
"CreationDateTime": "2023-01-19T06:18:12.762Z",
"Status": "Authorised",
"StatusUpdateDateTime": "2023-01-19T06:18:12.762Z",
"CutOffDateTime": "2023-01-19T06:18:12.762Z",
"ExpectedExecutionDateTime": "2023-01-19T06:18:12.762Z",
"ExpectedSettlementDateTime": "2023-01-19T06:18:12.762Z",
"Charges": [
{
"ChargeBearer": "BorneByCreditor",
"Type": [
"UK.OBIE.CHAPSOut",
"UK.OBIE.BalanceTransferOut",
"UK.OBIE.MoneyTransferOut"
],
"Amount": {
"Amount": "165.88",
"Currency": "GBP"
}
}
],
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"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"
],
"InstructedAmount": {
"Amount": "165.88",
"Currency": "GBP"
},
"DebtorAccount": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "08080021325698",
"Name": "ACME Inc",
"SecondaryIdentification": "0002"
},
"CreditorAccount": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "08080021325698",
"Name": "ACME Inc",
"SecondaryIdentification": "0002"
},
"CreditorPostalAddress": {
"AddressType": "Business",
"Department": "Wessex",
"SubDepartment": "Wessex",
"StreetName": "Acacia Lodge",
"BuildingNumber": "235",
"PostCode": "GU31 2ZZ",
"TownName": "Sparsholt",
"CountrySubDivision": "Wessex",
"Country": "UK",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
},
"SupplementaryData": {}
},
"Authorisation": {
"AuthorisationType": "Any",
"CompletionDateTime": "2023-01-19T06:18:12.762Z"
}
},
"Risk": {
"PaymentContextCode": "BillPayment",
"MerchantCategoryCode": "stri",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"StreetName": "Acacia Avenue",
"BuildingNumber": "235",
"PostCode": "GU31 2ZZ",
"TownName": "Sparsholt",
"CountrySubDivision": [
"Wessex"
],
"Country": "UK"
}
},
"Links": {
"Self": "https://example.com",
"First": "https://example.com",
"Prev": "https://example.com",
"Next": "https://example.com",
"Last": "https://example.com"
},
"Meta": {
"TotalPages": 5,
"FirstAvailableDateTime": "2023-01-19T06:18:12.762Z",
"LastAvailableDateTime": "2023-01-19T06:18:12.762Z"
}
}
Get domestic payment consents funds confirmation
Use this method to obtain detailed information about funds confirmation of a specified payment consent.
Request
Header parameters:
- Authorization
The authorization token as per https://tools.ietf.org/html/rfc6750.
- x-fapi-financial-id required
The unique identifier of the ASPSP issued by the Open Banking system.
- x-fapi-customer-last-logged-time
The date and time when the PSU has last logged in system using a TPP application.
- x-fapi-customer-ip-address
The IP address of the PSU who has logged in system using a TPP application.
- x-fapi-interaction-id
The unique identifier of the initiating party (as per RFC4122 UID) used as a correlation identifier.
- x-customer-user-agent
The user-agent used by the PSU.
Path parameters:
- ConsentId required
The consent identifier.
GET[base]/domestic-payment-consents/{consentId}/funds-confirmation
GET /domestic-payment-consents/consent-id-example/funds-confirmation HTTP/1.1
Authorization: Bearer <token>
x-fapi-financial-id: b621cec4-e775-49ab-980a-1900c6a09620
x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
Response
Body:
- Data object
This object provides the following data:
Expand fields- FundsAvailableDateTime string
The date and time when a funds availability check was generated.
- FundsAvailable boolean
The availability of funds based on the amount indicated in the consent request.
- SupplementaryData object
The additional information about a transaction.
HTTP status codes:
The eqwire API uses standard HTTP response codes to indicate the success or failure of a request.
To view a full list of valid response codes, refer to HTTP response codes.
{
"Data": {
"FundsAvailableResult": {
"FundsAvailableDateTime": "2023-01-19T06:35:16.778Z",
"FundsAvailable": true
},
"SupplementaryData": {}
},
"Links": {
"Self": "https://example.com",
"First": "https://example.com",
"Prev": "https://example.com",
"Next": "https://example.com",
"Last": "https://example.com"
},
"Meta": {
"TotalPages": 5,
"FirstAvailableDateTime": "2023-01-19T06:35:16.778Z",
"LastAvailableDateTime": "2023-01-19T06:35:16.778Z"
}
}
Initiate a domestic payment
Use this method to initiate a payment transaction.
Request
Header parameters:
- Authorization
The authorization token as per https://tools.ietf.org/html/rfc6750 .
- x-idempotency-key required
The unique key that the resource server uses to recognize subsequent retries of the same request.
Every request is only processed once as per
x-idempotency-key
which is valid for 24 hours.- x-jws-signature required
The detached JSON WEB signature (JWS) of the payload body.
- x-fapi-financial-id required
The unique identifier of the ASPSP issued by the Open Banking system.
- x-fapi-customer-last-logged-time
The date and time when the PSU has last logged in the system using a TPP application.
- x-fapi-customer-ip-address
The IP address of the PSU who has logged in the system using a TPP application.
- x-fapi-interaction-id
The unique identifier of the initiating party (as per RFC 4122 UID) used as a correlation identifier.
- x-customer-user-agent
The user-agent used by the PSU.
Body
- Data object required
This object provides the following data:
Expand fields- ConsentId string
The consent identifier.
- Initiation object
This object provides the following data:
Expand fields- InstructionIdentification string
The unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
- EndToEndIdentification string
The unique identification assigned by the initiating party to identify the transaction.
The Faster Payments Scheme can only access
31
characters for theEndToEndIdentification
field.- LocalInstrument string
The local clearing option specifying the service.
Example:
"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"
- InstructedAmount object
This object provides the following data:
Expand fields- Amount string
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. This amount has to be transported unchanged through the transaction chain.
- Currency string
The currency of a transaction as per ISO 4217.
- DebtorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a debtor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a creditor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorPostalAddress object
This object provides the following data:
Expand fields- AddressType string
The address type of an agent. Possible values:
Business
Correspondence
DeliveryTo
MailTo
POBox
Postal
Residential
Statement
- Department string
The department of the building of an agent.
- SubDepartment string
The subdepartment of the building of an agent.
- StreetName string
The name of the street of an agent.
- BuildingNumber string
The number of the building of an agent.
- PostCode string
The postal code of an agent.
- TownName string
The name the town of an agent.
- CountrySubDivision string
The subdivision of the country of an agent.
- Country string
The country of an agent.
- AddressLine array
The address line of an agent.
- RemittanceInformation object
This object provides the following data:
Expand fields- Unstructured string
The information supplied to enable the matching and reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts receivable system, in an unstructured form.
- Reference string
The unique reference to the payment transaction assigned by the creditor.
If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
The Faster Payments Scheme can only accept
18
characters for theReferenceInformation field
.
- SupplementaryData object
The additional information about a transaction.
- Risk object
The parameters of the Risk section are sent to the ASPSP by the initiating party.
This information is used to specify additional details for the payments risk scoring.
This object provides the following data:
Expand fields- PaymentContextCode string
The payment context specification. Possible values:
BillPayment
EcommerceGoods
EcommerceServices
Other
PartyToParty
- MerchantCategoryCode string
The category code as per ISO 18245, related to the type of services or goods the merchant provides for the transaction.
- MerchantCustomerIdentification string
The unique customer identifier of the merchant.
- DeliveryAddress object
This object provides the following data:
Expand fields- AddressLine array
The address line for the delivery.
- StreetName string
The name of the street.
- BuildingNumber string
The number of the building.
- PostCode string
The postal code.
- TownName string
The name the town.
- CountrySubDivision string
The subdivision of the country.
- Country string
The name of the country.
POST[base]/domestic-payments
{
"Data": {
"ConsentId": "urn-bank-intent-88379",
"Initiation": {
"InstructionIdentification": "ACME412",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"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"
],
"InstructedAmount": {
"Amount": "165.88",
"Currency": "GBP"
},
"DebtorAccount": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "08080021325698",
"Name": "ACME Inc",
"SecondaryIdentification": "0002"
},
"CreditorAccount": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "08080021325698",
"Name": "ACME Inc",
"SecondaryIdentification": "0002"
},
"CreditorPostalAddress": {
"AddressType": "Business",
"Department": "Wessex",
"SubDepartment": "Wessex",
"StreetName": "Acacia Avenue",
"BuildingNumber": "235",
"PostCode": "GU31 2ZZ",
"TownName": "Sparsholt",
"CountrySubDivision": "Wessex",
"Country": "UK",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
},
"SupplementaryData": {}
}
},
"Risk": {
"PaymentContextCode": "BillPayment",
"MerchantCategoryCode": "stri",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"StreetName": "Acacia Avenue",
"BuildingNumber": "235",
"PostCode": "GU31 2ZZ",
"TownName": "Sparsholt",
"CountrySubDivision": [
"Wessex"
],
"Country": "UK"
}
}
}
Response
Body:
- Data object
This object provides the following data:
Expand fields- DomesticPaymentId string
The unique identifier of a domestic payment transaction.
- ConsentId string
The consent identifier.
- CreationDateTime string
The date and time of a domestic payment transaction.
- Status string
The consent status. Possible values:
AcceptedSettlementCompleted
AcceptedSettlementInProcess
Pending
Rejected
- StatusUpdateDateTime string
The date and time when the status of a payment transaction was updated.
- ExpectedExecutionDateTime string
The date and time when a payment transaction is expected to be executed.
- ExpectedSettlementDateTime string
The date and time of a payment transaction settlement.
- charges array
This array provides the following data:
Expand fields- ChargeBearer string
The party which bears the charges associated with the processing of a payment transaction. Possible values:
BorneByCreditor
BorneByDebtor
FollowingServiceLevel
Shared
- Type string
The charge type, in a coded form.
Example:
"UK.OBIE.CHAPSOut"
"UK.OBIE.BalanceTransferOut"
"UK.OBIE.MoneyTransferOut"
- Amount string
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. This amount has to be transported unchanged through the transaction chain.
- Currency string
The currency of a transaction as per ISO 4217.
- Initiation object
This object provides the following data:
Expand fields- InstructionIdentification string
The unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.
- EndToEndIdentification string
The unique identification assigned by the initiating party to identify the transaction.
The Faster Payments Scheme can only access
31
characters for theEndToEndIdentification
field.- LocalInstrument string
The local clearing option specifying the service.
Example:
"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"
- InstructedAmount object
This object provides the following data:
Expand fields- Amount string
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. This amount has to be transported unchanged through the transaction chain.
- Currency string
The currency of a transaction as per ISO 4217.
- DebtorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a debtor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a creditor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorPostalAddress object
This object provides the following data:
Expand fields- AddressType string
The address type of an agent. Possible values:
Business
Correspondence
DeliveryTo
MailTo
POBox
Postal
Residential
Statement
- Department string
The department of the building of an agent.
- SubDepartment string
The subdepartment of the building of an agent.
- StreetName string
The name of the street of an agent.
- BuildingNumber string
The number of the building of an agent.
- PostCode string
The postal code of an agent.
- TownName string
The name the town of an agent.
- CountrySubDivision string
The subdivision of the country of an agent.
- Country string
The country of an agent.
- AddressLine array
The address line of an agent.
- RemittanceInformation object
This object provides the following data:
Expand fields- Unstructured string
The information supplied to enable the matching and reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts receivable system, in an unstructured form.
- Reference string
The unique reference to the payment transaction assigned by the creditor.
If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
The Faster Payments Scheme can only accept
18
characters for theReferenceInformation field
.
- SupplementaryData object
The additional information about a transaction.
- MultiAuthorization object
This object provides the following data:
Expand fields- Status string
The authorization type. Possible values:
Authorized
AwaitingFurtherAuthorization
Rejected
- NumberRequired integer
The total number of authorisations required for a payment order.
- NumberReceived integer
The total number of authorisations received for a payment order.
- LastUpdateDateTime string
The date and time when an authorization has last been updated.
- ExpirationDateTime string
The date and time when an authorization is due to expire.
HTTP status codes:
The eqwire API uses standard HTTP response codes to indicate the success or failure of a request.
To view a full list of valid response codes, refer to HTTP response codes.
RESPONSE EXAMPLE{ "Data": { "DomesticPaymentId": "58923-001", "ConsentId": "58923", "CreationDateTime": "2023-01-19T06:57:02.064Z", "Status": "AcceptedSettlementCompleted", "StatusUpdateDateTime": "2023-01-19T06:57:02.064Z", "ExpectedExecutionDateTime": "2023-01-19T06:57:02.064Z", "ExpectedSettlementDateTime": "2023-01-19T06:57:02.064Z", "Charges": [ { "ChargeBearer": "BorneByCreditor", "Type": [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ], "Amount": { "Amount": "165.88", "Currency": "GBP" } } ], "Initiation": { "InstructionIdentification": "ACME412", "EndToEndIdentification": "FRESCO.21302.GFX.20", "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" ], "InstructedAmount": { "Amount": "165.88", "Currency": "GBP" }, "DebtorAccount": { "SchemeName": [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ], "Identification": "08080021325698", "Name": "ACME Inc", "SecondaryIdentification": "0008" }, "CreditorAccount": { "SchemeName": [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ], "Identification": "08080021325677", "Name": "NTPC Inc", "SecondaryIdentification": "0002" }, "CreditorPostalAddress": { "AddressType": "Business", "Department": "Wessex", "SubDepartment": "Wessex", "StreetName": "Acacia Lodge", "BuildingNumber": "235", "PostCode": "GU31 2ZZ", "TownName": "Sparsholt", "CountrySubDivision": "Wessex", "Country": "UK", "AddressLine": [ "Flat 7", "Acacia Lodge" ] }, "RemittanceInformation": { "Unstructured": "Internal ops code 5120101", "Reference": "FRESCO-101" }, "SupplementaryData": {} }, "MultiAuthorisation": { "Status": "Authorised", "NumberRequired": 0, "NumberReceived": 0, "LastUpdateDateTime": "2023-01-19T06:57:02.064Z", "ExpirationDateTime": "2023-01-19T06:57:02.064Z" } }, "Links": { "Self": "https://example.com", "First": "https://example.com", "Prev": "https://example.com", "Next": "https://example.com", "Last": "https://example.com" }, "Meta": { "TotalPages": 5, "FirstAvailableDateTime": "2023-01-19T06:57:02.064Z", "LastAvailableDateTime": "2023-01-19T06:57:02.064Z" } }
Get domestic payment details
Use this method to obtain detailed information about a specified domestic payment.
Request
Header parameters:
- Authorization
The authorization token as per https://tools.ietf.org/html/rfc6750.
- x-fapi-financial-id required
The unique identifier of the ASPSP issued by the Open Banking system.
- x-fapi-customer-last-logged-time
The date and time when the PSU has last logged in system using a TPP application.
- x-fapi-customer-ip-address
The IP address of the PSU who has logged in system using a TPP application.
- x-fapi-interaction-id
The unique identifier of the initiating party (as per RFC4122 UID) used as a correlation identifier.
- x-customer-user-agent
The user-agent used by the PSU.
Path parameters:
- domesticPaymentId required
The consent identifier.
GET[base]/domestic-payments/{domesticPaymentId}
GET /domestic-payments/domestic-payment-id-example HTTP/1.1
Authorization: Bearer <token>
x-fapi-financial-id: b621cec4-e775-49ab-980a-1900c6a09620
x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
Response
Body:
- Data object
This object provides the following data:
Expand fields- DomesticPaymentId string
The unique identifier of a domestic payment transaction.
- ConsentId string
The consent identifier.
- CreationDateTime string
The date and time of a domestic payment transaction.
- Status string
The consent status. Possible values:
AcceptedSettlementCompleted
AcceptedSettlementInProcess
Pending
Rejected
- StatusUpdateDateTime string
The date and time when the status of a payment transaction was updated.
- ExpectedExecutionDateTime string
The date and time when a payment transaction is expected to be executed.
- ExpectedSettlementDateTime string
The date and time of a payment transaction settlement.
- charges array
This array provides the following data:
Expand fields- ChargeBearer string
The party which bears the charges associated with the processing of a payment transaction. Possible values:
BorneByCreditor
BorneByDebtor
FollowingServiceLevel
Shared
- Type string
The charge type, in a coded form.
Example:
"UK.OBIE.CHAPSOut"
"UK.OBIE.BalanceTransferOut"
"UK.OBIE.MoneyTransferOut"
- Amount string
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. This amount has to be transported unchanged through the transaction chain.
- Currency string
The currency of a transaction as per ISO 4217.
- Initiation object
This object provides the following data:
Expand fields- InstructionIdentification string
The unique identification assigned by an instructing party to identify the instruction.
- EndToEndIdentification string
The unique identification assigned by the initiating party to identify the transaction.
The Faster Payments Scheme can only access
31
characters for theEndToEndIdentification
field.- LocalInstrument string
The local clearing option specifying the service.
Example:
"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"
- InstructedAmount object
This object provides the following data:
Expand fields- Amount string
The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. This amount has to be transported unchanged through the transaction chain.
- Currency string
The currency of a transaction as per ISO 4217.
- DebtorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a debtor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorAccount object
This object provides the following data:
Expand fields- SchemeName string
The name of a scheme.
- Identification string
The identifier of the financial institution of a creditor account.
- Name string
The name of an account.
- SecondaryIdentification string
The secondary identification of an account assigned by the account servicing institution.
- CreditorPostalAddress object
This object provides the following data:
Expand fields- AddressType string
The address type of an agent. Possible values:
Business
Correspondence
DeliveryTo
MailTo
POBox
Postal
Residential
Statement
- Department string
The department of the building of an agent.
- SubDepartment string
The subdepartment of the building of an agent.
- StreetName string
The name of the street of an agent.
- BuildingNumber string
The number of the building of an agent.
- PostCode string
The postal code of an agent.
- TownName string
The name the town of an agent.
- CountrySubDivision string
The subdivision of the country of an agent.
- Country string
The country of an agent.
- AddressLine array
The address line of an agent.
- RemittanceInformation object
This object provides the following data:
Expand fields- Unstructured string
The information supplied to enable the matching and reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts receivable system, in an unstructured form.
- Reference string
The unique reference to the payment transaction assigned by the creditor.
If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
The Faster Payments Scheme can only accept
18
characters for theReferenceInformation field
.
- SupplementaryData object
The additional information about a transaction.
- MultiAuthorization object
This object provides the following data:
Expand fields- Status string
The authorization type. Possible values:
Authorized
AwaitingFurtherAuthorization
Rejected
- NumberRequired integer
The total number of authorisations required for a payment order.
- NumberReceived integer
The total number of authorisations received for a payment order.
- LastUpdateDateTime string
The date and time when an authorization has last been updated.
- ExpirationDateTime string
The date and time when an authorization is due to expire.
HTTP status codes:
The eqwire API uses standard HTTP response codes to indicate the success or failure of a request.
To view a full list of valid response codes, refer to HTTP response codes.
RESPONSE EXAMPLE{ "Data": { "DomesticPaymentId": "58923-001", "ConsentId": "58923", "CreationDateTime": "2023-01-19T07:18:51.933Z", "Status": "AcceptedSettlementCompleted", "StatusUpdateDateTime": "2023-01-19T07:18:51.933Z", "ExpectedExecutionDateTime": "2023-01-19T07:18:51.933Z", "ExpectedSettlementDateTime": "2023-01-19T07:18:51.933Z", "Charges": [ { "ChargeBearer": "BorneByCreditor", "Type": [ "UK.OBIE.CHAPSOut", "UK.OBIE.BalanceTransferOut", "UK.OBIE.MoneyTransferOut" ], "Amount": { "Amount": "165.88", "Currency": "GBP" } } ], "Initiation": { "InstructionIdentification": "ACME412", "EndToEndIdentification": "FRESCO.21302.GFX.20", "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" ], "InstructedAmount": { "Amount": "165.88", "Currency": "GBP" }, "DebtorAccount": { "SchemeName": [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ], "Identification": "08080021325698", "Name": "ACME Inc", "SecondaryIdentification": "0002" }, "CreditorAccount": { "SchemeName": [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ], "Identification": "08080021325698", "Name": "ACME Inc", "SecondaryIdentification": "0002" }, "CreditorPostalAddress": { "AddressType": "Business", "Department": "Wessex", "SubDepartment": "Wessex", "StreetName": "Acacia Lodge", "BuildingNumber": "235", "PostCode": "GU31 2ZZ", "TownName": "Sparsholt", "CountrySubDivision": "Wessex", "Country": "UK", "AddressLine": [ "Flat 7", "Acacia Lodge" ] }, "RemittanceInformation": { "Unstructured": "Internal ops code 5120101", "Reference": "FRESCO-101" }, "SupplementaryData": {} }, "MultiAuthorisation": { "Status": "Authorised", "NumberRequired": 0, "NumberReceived": 0, "LastUpdateDateTime": "2023-01-19T07:18:51.933Z", "ExpirationDateTime": "2023-01-19T07:18:51.933Z" } }, "Links": { "Self": "https://example.com", "First": "https://example.com", "Prev": "https://example.com", "Next": "https://example.com", "Last": "https://example.com" }, "Meta": { "TotalPages": 5, "FirstAvailableDateTime": "2023-01-19T07:18:51.933Z", "LastAvailableDateTime": "2023-01-19T07:18:51.933Z" } }