FPS inbound payment processed
Type: object
Domain: fps
Event: fps_in
Version: 1
account_id required
Title: Account unique identifier
Description: Account identifier generated by pismo
Type: integer
Example:
1
transaction_id required
Title: Transaction Identifier
Description: Unique identification for transaction on pismo
Type: string
Max length: 18
Example:
1
end_to_end_id required
Title: Payment End-to-End Identifier
Description: Unique identification, as assigned by the initiating party to unambiguously identify the payment.
Type: string
Max length: 35
Example:
72db39cd1693
fpid
Title: Identifier on FasterPayment system
Description: Identifier on FasterPayment system
Type: string or null
Max length: 35
Example:
null
e6e7ab2a97d1
debtor_account required
Type: object
scheme required
Title: Scheme Name
Description: Name of the identification scheme.
Type: string
Max length: 21
Example:
IBANidentification required
Title: identification
Description: Identification assigned by an institution to identify an account.
Type: string
Max length: 34
Example:
GB00CUBK22002243218765
creditor_account required
Type: object
name
Title: Name
Description: The account name of the creditor's account.
Type: string
Max length: 60
Example:
Jane Smithscheme required
Title: Scheme Name
Description: Name of the identification scheme.
Type: string
Max length: 21
Example:
IBANidentification required
Title: identification
Description: Identification assigned by an institution to identify an account.
Type: string
Max length: 34
Example:
GB00CUBK44556687654321
instructed_amount required
Type: object
amount required
Title: FPS Payment Amount
Description: Amount of money to be moved between the debtor and creditor.
Type: number
Format: double
Example:
88.52currency required
Title: Currency
Description: Identification of the currency in which the account is held.
Type: string
Max length: 3
Example:
GBP
remittance_information required
Type: object
reference required
Title: Reference
Description: Reference information provided by the initiating party to unambiguously identify the remittance information.
Type: string
Example:
51dcf7ba480e61c5a60bbb6c6b774d17
originated_overseas
Description: Information for Payment Originated Overseas transaction. Will be
nullfor non international payments
Type: object or nullultimate_debtor required
Type: object
name required
Title: Ultimate debtor name
Description: The debtor name on the foreign account
Type: string
Example:
nulladdress required
Title: Ultimate debtor address
Description: The debtor address
Type: string
Example:
501 Congress Avenue, Suite 150 Austin, TX 78701ultimate_debtor_account required
Type: object
scheme_name required
Title: Debtor bank scheme name
Description: The debtor bank scheme name
Type: string
Example:
BICidentification required
Title: Bank identification based on the scheme
Description: The debtor address
Type: string
Example:
USBKUS44XXXaccount_number required
Title: Debtor bank account number
Description: The debtor's bank account number
Type: string
Example:
12837823
status required
Title: Status
Description: Status of the FPS Payment.
Type: string
Example:
SETTLED
RETURNED
CANCELLED
REJECTED
status_reason
Type: object or null
description required
Title: Reason description
Description: Description of the status reason
Example:
Insufficient Fundscode required
Title: Reason error code
Description: Reason error code
Example:
EFPS0025
creation_date_time required
Title: Creation Date Time
Description: Date and time at which the FPS Payment was created.
Type: string
Example:
2019-01-01T11:12:05.101Z
update_date_time required
Title: Update Date Time
Description: Date and time at which the FPS Payment was last updated.
Type: string
Example:
2019-01-01T11:12:05.101Z
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "FPS inbound payment processed",
"required": [
"account_id",
"transaction_id",
"end_to_end_id",
"debtor_account",
"creditor_account",
"instructed_amount",
"remittance_information",
"status",
"creation_date_time",
"update_date_time"
],
"properties": {
"account_id": {
"type": "integer",
"title": "Account unique identifier",
"description": "Account identifier generated by pismo",
"examples": [
1
]
},
"transaction_id": {
"type": "string",
"title": "Transaction Identifier",
"description": "Unique identification for transaction on pismo",
"maxLength": 18,
"examples": [
"1"
]
},
"end_to_end_id": {
"type": "string",
"title": "Payment End-to-End Identifier",
"description": "Unique identification, as assigned by the initiating party to unambiguously identify the payment.",
"maxLength": 35,
"examples": [
"72db39cd1693"
]
},
"fpid": {
"type": [
"string",
"null"
],
"title": "Identifier on FasterPayment system",
"description": "Identifier on FasterPayment system",
"maxLength": 35,
"examples": [
null,
"e6e7ab2a97d1"
]
},
"debtor_account": {
"type": "object",
"required": [
"scheme",
"identification"
],
"properties": {
"scheme": {
"type": "string",
"title": "Scheme Name",
"description": "Name of the identification scheme.",
"maxLength": 21,
"examples": [
"IBAN"
]
},
"identification": {
"type": "string",
"title": "identification",
"description": "Identification assigned by an institution to identify an account.",
"maxLength": 34,
"examples": [
"GB00CUBK22002243218765"
]
}
}
},
"creditor_account": {
"type": "object",
"required": [
"scheme",
"identification"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The account name of the creditor's account.",
"maxLength": 60,
"examples": [
"Jane Smith"
]
},
"scheme": {
"type": "string",
"title": "Scheme Name",
"description": "Name of the identification scheme.",
"maxLength": 21,
"examples": [
"IBAN"
]
},
"identification": {
"type": "string",
"title": "identification",
"description": "Identification assigned by an institution to identify an account.",
"maxLength": 34,
"examples": [
"GB00CUBK44556687654321"
]
}
}
},
"instructed_amount": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"title": "FPS Payment Amount",
"description": "Amount of money to be moved between the debtor and creditor.",
"examples": [
88.52
]
},
"currency": {
"type": "string",
"title": "Currency",
"description": "Identification of the currency in which the account is held.",
"maxLength": 3,
"examples": [
"GBP"
]
}
}
},
"remittance_information": {
"type": "object",
"required": [
"reference"
],
"properties": {
"reference": {
"type": "string",
"title": "Reference",
"description": "Reference information provided by the initiating party to unambiguously identify the remittance information.",
"examples": [
"51dcf7ba480e61c5a60bbb6c6b774d17"
]
}
}
},
"originated_overseas": {
"description": "Information for Payment Originated Overseas transaction. Will be `null` for non international payments",
"type": [
"object",
"null"
],
"required": [
"ultimate_debtor",
"ultimate_debtor_account"
],
"properties": {
"ultimate_debtor": {
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"title": "Ultimate debtor name",
"description": "The debtor name on the foreign account",
"examples": [
""
]
},
"address": {
"type": "string",
"title": "Ultimate debtor address",
"description": "The debtor address",
"examples": [
"501 Congress Avenue, Suite 150 Austin, TX 78701"
]
}
}
},
"ultimate_debtor_account": {
"type": "object",
"required": [
"scheme_name",
"identification",
"account_number"
],
"properties": {
"scheme_name": {
"type": "string",
"title": "Debtor bank scheme name",
"description": "The debtor bank scheme name",
"examples": [
"BIC"
]
},
"identification": {
"type": "string",
"title": "Bank identification based on the scheme",
"description": "The debtor address",
"examples": [
"USBKUS44XXX"
]
},
"account_number": {
"type": "string",
"title": "Debtor bank account number",
"description": "The debtor's bank account number",
"examples": [
"12837823"
]
}
}
}
}
},
"status": {
"type": "string",
"title": "Status",
"description": "Status of the FPS Payment.",
"examples": [
"SETTLED",
"RETURNED",
"CANCELLED",
"REJECTED"
]
},
"status_reason": {
"type": [
"object",
"null"
],
"required": [
"code",
"description"
],
"properties": {
"description": {
"title": "Reason description",
"description": "Description of the status reason",
"examples": [
"Insufficient Funds"
]
},
"code": {
"title": "Reason error code",
"description": "Reason error code",
"examples": [
"EFPS0025"
]
}
}
},
"creation_date_time": {
"type": "string",
"title": "Creation Date Time",
"description": "Date and time at which the FPS Payment was created.",
"examples": [
"2019-01-01T11:12:05.101Z"
]
},
"update_date_time": {
"type": "string",
"title": "Update Date Time",
"description": "Date and time at which the FPS Payment was last updated.",
"examples": [
"2019-01-01T11:12:05.101Z"
]
}
}
}
Updated 7 days ago