Retrieve all direct debit payments associated with a direct debit mandate. The permision needed to access this endpoint is PERM_BUSINESS_GET_DIRECT_DEBITS
643 matches
27 actions
Fire Financial Services Business
27 actions
- Activate a direct debit mandatePOSTv1.0.0
- Add a new accountPOSTv1.0.0
- Authenticate with the API.POSTv1.0.0
- Block a cardPOSTv1.0.0
- Cancel a direct debit mandatePOSTv1.0.0
- Create a Fire Open Payment requestPOSTv1.0.0
- Create a new API ApplicationPOSTv1.0.0
- Create a new debit card.POSTv1.0.0
- Filtered list of transactions for an account (v1)GETv1.0.0
- Get all DD payments associated with a direct debit mandateGETv1.0.0
- Get direct debit mandate detailsGETv1.0.0
- Get list of ASPSPs / BanksGETv1.0.0
- Get Payment DetailsGETv1.0.0
- Get the details of a direct debitGETv1.0.0
- List all direct debit mandatesGETv1.0.0
- List all fire.com AccountsGETv1.0.0
- List all Payee Bank AccountsGETv1.0.0
- List Card Transactions.GETv1.0.0
- List transactions for an account (v1)GETv1.0.0
- List transactions for an account (v3)GETv1.0.0
- Reject a direct debit paymentPOSTv1.0.0
- Retrieve the details of a fire.com AccountGETv1.0.0
- Returns details of a specific fire.com user.GETv1.0.0
- Returns list of all users on your fire.com accountGETv1.0.0
- Unblock a cardPOSTv1.0.0
- Update a direct debit mandate aliasPOSTv1.0.0
- View List of Cards.GETv1.0.0
Finance/Fire Financial Services Business
Get all DD payments associated with a direct debit mandate
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
{
"type": "object",
"properties": {
"mandateUuid": {
"type": "string"
}
},
"required": [
"mandateUuid"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
{
"type": "object",
"properties": {
"directdebits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"format": "int64",
"description": "Value of the payment"
},
"currency": {
"type": "object",
"description": "The currency.",
"properties": {
"code": {
"type": "string",
"description": "The three letter code for the currency - either `EUR` or `GBP`.",
"enum": [
"EUR",
"GBP"
]
},
"description": {
"type": "string",
"description": "The name of the currency"
}
}
},
"dateCreated": {
"type": "string",
"format": "date-time",
"description": "Date the direct debit was created. Milliseconds since the epoch (1970)."
},
"directDebitReference": {
"type": "string",
"description": "The direct debit reference."
},
"directDebitUuid": {
"type": "string",
"description": "The UUID for the direct debit payment"
},
"isDDIC": {
"type": "boolean",
"description": "DDIC is a Direct Debit Indemnity Claim (i.e.a refund). If if the DD is requested to be refunded it is marked isDDIC true."
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"description": "Date the direct debit was last updated. Milliseconds since the epoch (1970)."
},
"mandateUUid": {
"type": "string",
"description": "The UUID for the mandate"
},
"originatorAlias": {
"type": "string",
"description": "The Alias of the party who sets up the direct debit."
},
"originatorName": {
"type": "string",
"description": "The creator of the party who sets up the direct debit."
},
"originatorReference": {
"type": "string",
"description": "Set by party who sets up the direct debit."
},
"schemeRejectReason": {
"type": "string",
"description": "Reason why rejected"
},
"schemeRejectReasonCode": {
"type": "string",
"description": "The reject code returned by the bank indicating an issue with the direct debit. Each ARRUD code represents a rejection reason.",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"A",
"B"
]
},
"status": {
"type": "string",
"description": "The statuses of the direct debit payments associated with the mandate.\n* 'RECIEVED' - Direct Debit has been recieved\n* 'REJECT_REQUESTED' - The direct debit has a rejected request associated with it\n* 'REJECT_READY_FOR_PROCESSING' \n* 'REJECT_RECORD_IN_PROGRESS'\n* 'REJECT_RECORDED'\n* 'REJECT_FILE_CREATED'\n* 'REJECT_FILE_SENT'\n* 'COLLECTED' - Direct debit collected\n* 'REFUND_REQUESTED' - Refund requested on direct debit\n* 'REFUND_RECORD_IN_PROGRESS' - Refund in progress on direct debit\n* 'REFUND_RECORDED'\n* 'REFUND_FILE_CREATED'\n* 'REFUND_FILE_SENT' \n",
"enum": [
"RECIEVED",
"REJECT_REQUESTED",
"REJECT_READY_FOR_PROCESSING",
"REJECT_RECORD_IN_PROGRESS",
"REJECT_RECORDED",
"REJECT_FILE_CREATED",
"REJECT_FILE_SENT",
"COLLECTED",
"REFUND_REQUESTED",
"REFUND_RECORD_IN_PROGRESS",
"REFUND_RECORDED",
"REFUND_FILE_CREATED",
"REFUND_FILE_SENT"
]
},
"targetIcan": {
"type": "integer",
"format": "int64",
"description": "The ican of your fire account that the money was taken from"
},
"targetPayeeId": {
"type": "integer",
"format": "int64",
"description": "The payee that was created when the DD was processed"
},
"type": {
"type": "string",
"description": "The type of the direct debit.",
"enum": [
"FIRST_COLLECTION",
"ONGOING_COLLECTION",
"REPRESENTED_COLLECTION",
"FINAL_COLLECTION"
]
}
}
}
},
"total": {
"type": "integer",
"format": "int64",
"description": "Number of direct debits found"
}
}
}