Faster Payment payment processed

Faster Payment System (FPS) payment processed. The Send Faster payment endpoint generates this event.

Type: object
Domain: fps
Event: fps_out
Version: 1

account_id required

Title: Account ID
Description: Pismo account ID
Type: integer
Example:
1

transaction_id required

Title: Transaction ID
Description: Unique Pismo platform transaction ID.
Type: string
Max length: 18
Example:
1

end_to_end_id required

Title: Payment end to end ID
Description: Client-assigned unique ID to unambiguously ID the payment.
Type: string
Max length: 35
Example:
72db39cd1693

fpid

Title: Faster Payment ID
Description: Faster Payment system ID.
Type: string or null
Max length: 35
Example:
null
e6e7ab2a97d1

debtor_account required

Type: object

scheme required

Title: Scheme name
Description: Account identification scheme. BIC = Bank Identifier Code, also known as a SWIFT code, either 8 or 11 characters.
Type: string
Max length: 21
Must be one of the following:
BIC

identification required

Title: identification
Description: Account identification value.
Type: string
Max length: 34
Example:
GB00CUBK22002243218765

creditor_account required

Type: object

name

Title: Name
Description: Creditor name.
Type: string
Max length: 60
Example:
Dinah Soar

scheme required

Title: Scheme Name
Description: Account identification scheme name.
Type: string
Max length: 21
Must be one of the following:
iban
bban
uk-scan
Example:
iban

identification required

Title: identification
Description: Account identification scheme value.
Type: string
Max length: 34
Example:
GB00CUBK44556687654321

instructed_amount required

Type: object

amount required

Title: FPS payment amount
Description: Amount exchanged between debtor and creditor.
Type: number
Format: double
Example:
88.52

currency required

Title: Currency
Description: ISO 4217 3-letter currency ID.
Type: string
Max length: 3
Example:
GBP

remittance_information required

Type: object

reference required

Title: Reference
Description: Client-generated reference ID to unambiguously identify the remittance information.
Type: string
Example:
51dcf7ba480e61c5a60bbb6c6b774d17

originated_overseas required

Description: Information for authorization_datetime overseas originated payment transaction. Will be null for non-international payments
Type: object or null

ultimate_debtor required

Type: object

name required

Title: Ultimate debtor name
Description: Debtor name.
Type: string
Example:
Jerry Atrick

address required

Title: Ultimate debtor address
Description: Debtor address
Type: string
Example:
501 Congress Avenue, Suite 150 Austin, TX 78701

ultimate_debtor_account required

Type: object

scheme_name required

Title: Debtor bank scheme name
Description: Debtor bank scheme name. BIC = Bank Identifier Code, also known as a SWIFT code, either 8 or 11 characters.
Type: string
Must be one of the following:
BIC

identification required

Title: Account ID
Description: Account scheme identification value.
Type: string
Example:
USBKUS44XXX

account_number required

Title: Debtor bank account number
Description: Debtor bank account number.
Type: string
Example:
8675309

status required

Title: Status
Description: FPS payment status.
Type: string
Example:
CREATED
SETTLED
CANCELLED
REJECTED

status_reason required

Type: object or null

description required

Title: Reason description
Description: Status reason description
Example:
Insufficient Funds

code required

Title: Reason error code
Description: Reason error code
Example:
EFPS0025

creation_date_time required

Title: Creation datetime
Description: FPS payment creation datetime.
Type: string
Example:
2019-01-01T11:12:05.101Z

update_date_time required

Title: Updated datetime
Description: FPS payment last updated datetime.
Type: string
Example:
2019-01-01T11:12:05.101Z

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Faster Payment payment processed",
    "description": "Faster Payment System (FPS) payment processed. The [Send Faster payment](https://developers.pismo.io/pismo-docs/reference/post-create-fps) endpoint generates this event.",
    "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 ID",
            "description": "Pismo account ID",
            "examples": [
                1
            ]
        },
        "transaction_id": {
            "type": "string",
            "title": "Transaction ID",
            "description": "Unique Pismo platform transaction ID.",
            "maxLength": 18,
            "examples": [
                "1"
            ]
        },
        "end_to_end_id": {
            "type": "string",
            "title": "Payment end to end ID",
            "description": "Client-assigned unique ID to unambiguously ID the payment.",
            "maxLength": 35,
            "examples": [
                "72db39cd1693"
            ]
        },
        "fpid": {
            "type": [
                "string",
                "null"
            ],
            "title": "Faster Payment ID",
            "description": "Faster Payment system ID.",
            "maxLength": 35,
            "examples": [
                null,
                "e6e7ab2a97d1"
            ]
        },
        "debtor_account": {
            "type": "object",
            "required": [
                "scheme",
                "identification"
            ],
            "properties": {
                "scheme": {
                    "type": "string",
                    "title": "Scheme name",
                    "description": "Account identification scheme. `BIC` = Bank Identifier Code, also known as a SWIFT code, either 8 or 11 characters.",
                    "maxLength": 21,
                    "enum": [
                        "BIC"
                    ]
                },
                "identification": {
                    "type": "string",
                    "title": "identification",
                    "description": "Account identification value.",
                    "maxLength": 34,
                    "examples": [
                        "GB00CUBK22002243218765"
                    ]
                }
            }
        },
        "creditor_account": {
            "type": "object",
            "required": [
                "scheme",
                "identification"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Name",
                    "description": "Creditor name.",
                    "maxLength": 60,
                    "examples": [
                        "Dinah Soar"
                    ]
                },
                "scheme": {
                    "type": "string",
                    "title": "Scheme Name",
                    "description": "Account identification scheme name.",
                    "maxLength": 21,
                    "enum": [
                        "iban",
                        "bban",
                        "uk-scan"
                    ],
                    "example": "iban"
                },
                "identification": {
                    "type": "string",
                    "title": "identification",
                    "description": "Account identification scheme value.",
                    "maxLength": 34,
                    "examples": [
                        "GB00CUBK44556687654321"
                    ]
                }
            }
        },
        "instructed_amount": {
            "type": "object",
            "required": [
                "amount",
                "currency"
            ],
            "properties": {
                "amount": {
                    "type": "number",
                    "format": "double",
                    "title": "FPS payment amount",
                    "description": "Amount exchanged between debtor and creditor.",
                    "examples": [
                        88.52
                    ]
                },
                "currency": {
                    "type": "string",
                    "title": "Currency",
                    "description": "ISO 4217 3-letter currency ID.",
                    "maxLength": 3,
                    "examples": [
                        "GBP"
                    ]
                }
            }
        },
        "remittance_information": {
            "type": "object",
            "required": [
                "reference"
            ],
            "properties": {
                "reference": {
                    "type": "string",
                    "title": "Reference",
                    "description": "Client-generated reference ID to unambiguously identify the remittance information.",
                    "examples": [
                        "51dcf7ba480e61c5a60bbb6c6b774d17"
                    ]
                }
            }
        },
        "originated_overseas": {
            "description": "Information for authorization_datetime overseas originated payment 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": "Debtor name.",
                            "examples": [
                                "Jerry Atrick"
                            ]
                        },
                        "address": {
                            "type": "string",
                            "title": "Ultimate debtor address",
                            "description": "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": "Debtor bank scheme name. `BIC` = Bank Identifier Code, also known as a SWIFT code, either 8 or 11 characters.",
                            "enum": [
                                "BIC"
                            ]
                        },
                        "identification": {
                            "type": "string",
                            "title": "Account ID",
                            "description": "Account scheme identification value.",
                            "examples": [
                                "USBKUS44XXX"
                            ]
                        },
                        "account_number": {
                            "type": "string",
                            "title": "Debtor bank account number",
                            "description": "Debtor bank account number.",
                            "examples": [
                                "8675309"
                            ]
                        }
                    }
                }
            }
        },
        "status": {
            "type": "string",
            "title": "Status",
            "description": "FPS payment status.",
            "examples": [
                "CREATED",
                "SETTLED",
                "CANCELLED",
                "REJECTED"
            ]
        },
        "status_reason": {
            "type": [
                "object",
                "null"
            ],
            "required": [
                "code",
                "description"
            ],
            "properties": {
                "description": {
                    "title": "Reason description",
                    "description": "Status reason description",
                    "examples": [
                        "Insufficient Funds"
                    ]
                },
                "code": {
                    "title": "Reason error code",
                    "description": "Reason error code",
                    "examples": [
                        "EFPS0025"
                    ]
                }
            }
        },
        "creation_date_time": {
            "type": "string",
            "title": "Creation datetime",
            "description": "FPS payment creation datetime.",
            "examples": [
                "2019-01-01T11:12:05.101Z"
            ]
        },
        "update_date_time": {
            "type": "string",
            "title": "Updated datetime",
            "description": "FPS payment last updated datetime.",
            "examples": [
                "2019-01-01T11:12:05.101Z"
            ]
        }
    }
}

{
    "account_id": 1,
    "transaction_id": "1",
    "end_to_end_id": "72db39cd1693",
    "fpid": "e6e7ab2a97d1",
    "debtor_account": {
        "scheme": "BIC",
        "identification": "GB00CUBK22002243218765"
    },
    "creditor_account": {
        "name": "Dinah Soar",
        "scheme": "iban",
        "identification": "GB00CUBK44556687654321"
    },
    "instructed_amount": {
        "amount": 88.52,
        "currency": "GBP"
    },
    "remittance_information": {
        "reference": "51dcf7ba480e61c5a60bbb6c6b774d17"
    },
    "originated_overseas": {
        "ultimate_debtor": {
            "name": "Jerry Atrick",
            "address": "501 Congress Avenue, Suite 150 Austin, TX 78701"
        },
        "ultimate_debtor_account": {
            "scheme_name": "BIC",
            "identification": "USBKUS44XXX",
            "account_number": "8675309"
        }
    },
    "status": "CREATED",
    "status_reason": {
        "description": "Insufficient Funds",
        "code": "EFPS0025"
    },
    "creation_date_time": "2019-01-01T11:12:05.101Z",
    "update_date_time": "2019-01-01T11:12:05.101Z"
}