Numeral API

Getting started
Environments
Authentication
Sign API requests
Webhooks
Verify webhooks
Idempotency
API versioning
Status codes
Rate limiting
Data types
- Currency codes and digits
Pagination
Metadata
Reason codes
Purpose codes

Payments

Payment orders
Incoming payments
Returns

Investigations

Return requests
Claims
Inquiries

Accounts

Connected accounts
Transactions
Balances

Counterparties

Counterparties
Counterparty accounts
Virtual accounts
Account holders
External accounts
Internal accounts
Direct debit mandates

Reconciliations

Expected payments
Payment captures
Reconciliations

Verification of Payee

Payee verification requests
Verification scheme participants
- Get supported identification types for a payee accountget
- Retrieve verification scheme participantget

Tools

Process payments
- Process paymentspost
Bulk actions
Custom fields
Payment retry rules
Bank code lookup
- Bank code lookup overview
- Bank code lookuppost
Health check
- Check platform healthget

Files

Files

Events

Events

Additional resources

Account verification
Account details
Address
Payment methods supported

Numeral API

Getting started
Environments
Authentication
Sign API requests
Webhooks
Verify webhooks
Idempotency
API versioning
Status codes
Rate limiting
Data types
- Currency codes and digits
Pagination
Metadata
Reason codes
Purpose codes

Payments

Payment orders
Incoming payments
Returns

Investigations

Return requests
Claims
Inquiries

Accounts

Connected accounts
Transactions
Balances

Counterparties

Counterparties
Counterparty accounts
Virtual accounts
Account holders
External accounts
Internal accounts
Direct debit mandates

Reconciliations

Expected payments
Payment captures
Reconciliations

Verification of Payee

Payee verification requests
Verification scheme participants
- Get supported identification types for a payee accountget
- Retrieve verification scheme participantget

Tools

Process payments
- Process paymentspost
Bulk actions
Custom fields
Payment retry rules
Bank code lookup
- Bank code lookup overview
- Bank code lookuppost
Health check
- Check platform healthget

Files

Files

Events

Events

Additional resources

Account verification
Account details
Address
Payment methods supported

Cancel file

post https://sandbox.numeral.io/v1/files/{id}/cancel

Cancel a file in status created. Canceling a file updates its status to canceled. The payment orders, returns, or return requests included in the file are updated to their previous status.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

uuid

required

The UUID of the file.

Responses

Response body

object

string

required

The UUID of the file.

object

string

required

Label used to identify this kind of object.

file

connected_account_id

uuid

required

deprecated

The ID of the connected account used to send or receive the file.

connected_account_ids

array of strings

required

The IDs of the connected accounts used to send or receive the file.

connected_account_ids*

direction

string

required

The transfer direction for the file_id: - outgoing for files sent or to be sent to the bank - incoming for files received from the bank

outgoing incoming

category

string

required

The category of the file.

bank_file payment_file report_file return_request_file return_file account_report account_statement account_notification inquiry_category denied_inquiry_file denied_return_request_file error_file_format unknown_file_format

format

string

required

The format of the file.

filename

string

required

The name of the file.

size

integer

required

≥ 0

The size of the file, expressed in bytes.

summary

object

required

A summary of the file, depending on its content.

status

string

required

The status of the file.

created approved canceled sent rejected processed received

bank_data

object

required

Bank data, such as message ID, in JSON key:value format.

message_ids

array of strings

required

message_ids*

status_details

string

required

The details of the status of this file, such as the rejection reason for instance.

created_at

date-time

required

The UTC timestamp of the creation of the file.

Response body

object

Updated 4 months ago

Approve file

List files

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox.numeral.io/v1/files/id/cancel \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 4 months ago

Approve file

List files

Did this page help you?

Numeral API
Getting started
Environments
Authentication
Sign API requests
Webhooks
Verify webhooks
Idempotency
API versioning
Status codes
Rate limiting
Data types
Currency codes and digits
Pagination
Metadata
Reason codes
FPS reason codes
Bacs reason codes
SEPA reason codes
Purpose codes

Payments
Payment orders
Retrieve payment orderget
Update payment orderpost
Retry payment orderpost
Cancel payment orderpost
Approve payment orderpost
List payment ordersget
Create payment orderpost
Payment order lifecycle
Payment order object
Incoming payments
List incoming paymentsget
Retrieve incoming paymentget
Update incoming paymentpost
Reject incoming paymentpost
Confirm incoming paymentpost
Incoming payment lifecycle
Incoming payment object
Returns
Cancel returnpost
Approve returnpost
Retrieve returnget
List returnsget
Create returnpost
Return lifecycle
Return object

Investigations
Return requests
Retrieve return requestget
Deny return requestpost
Accept return requestpost
List return requestsget
Create return requestpost
Return request lifecycle
Return request object
Claims
Retrieve claimget
List claimsget
Create claimpost
Claim lifecycle
Claim object
Inquiries
Retrieve inquiryget
List inquiriesget
Create inquirypost
Inquiry lifecycle
Deny inquirypost
Inquiry object

Accounts
Connected accounts
Retrieve connected accountget
List connected accountsget
Connected account object
Transactions
Retrieve transactionget
Update transactionpost
List transactionsget
Transaction lifecycle
Transaction object
Balances
Retrieve balanceget
List balancesget
Balance lifecycle
Balance object

Counterparties
Counterparties
Retrieve counterpartyget
Update counterpartypost
Disable counterpartypost
List counterpartiesget
Create counterpartypost
Counterparty lifecycle
Counterparty object
Counterparty accounts
Retrieve counterparty accountget
Update counterparty accountpost
Verify counterparty accountpost
Disable counterparty accountpost
Deny counterparty accountpost
Approve counterparty accountpost
List counterparty accountsget
Create counterparty accountpost
Counterparty account lifecycle
Counterparty account object
Virtual accounts
Retrieve virtual accountget
Update virtual accountpost
Disable virtual accountpost
Unassign virtual account from counterpartypost
Assign virtual account to counterpartypost
List virtual accountsget
Create virtual accountpost
Virtual account lifecycle
Virtual account object
Account holders
Retrieve account holderget
Update account holderpost
Disable account holderpost
List account holdersget
Create account holderpost
Account holder lifecycle
Account holder object
External accounts
Retrieve external accountget
Update external accountpost
Verify external accountpost
Disable external accountpost
Deny external accountpost
Approve external accountpost
List external accountsget
Create external accountpost
External account lifecycle
External account object
Internal accounts
Retrieve internal accountget
Disable internal accountpost
Unblock internal accountpost
Block internal accountpost
List internal accountsget
Create internal accountpost
Internal account lifecycle
Internal account object
Direct debit mandates
Authorize direct debit mandatepost
Block direct debit mandatepost
Disable direct debit mandatepost
Retrieve direct debit mandateget
Update direct debit mandatepost
List direct debit mandatesget
Create direct debit mandatepost
Direct debit mandate lifecycle
Direct debit mandate object

Reconciliations
Expected payments
Retrieve expected paymentget
Update expected paymentpost
Cancel expected paymentpost
List expected paymentsget
Create expected paymentpost
Expected payment lifecycle
Expected payment object
Payment captures
Retrieve payment captureget
Update payment capturepost
Cancel payment capturepost
List payment capturesget
Create payment capturepost
Payment capture lifecycle
Payment capture object
Reconciliations
Retrieve reconciliationget
Update reconciliationpost
Cancel reconciliationpost
List reconciliationsget
Create reconciliationpost
Reconciliation lifecycle
Reconciliation object

Verification of Payee
Payee verification requests
Simulate incoming payee verification requestpost
Retrieve payee verification requestget
List payee verification requestsget
Send verification payee requestpost
Payee verification request lifecycle
Payee verification request object
Verification scheme participants
Retrieve verification scheme participantget
Get supported identification types for a payee accountget

Tools
Process payments
Process paymentspost
Bulk actions
Retrieve bulk action related itemsget
Retrieve bulk actionget
List bulk actionsget
Create bulk actionpost
Bulk action lifecycle
Bulk action object
Custom fields
Retrieve custom fieldget
Update custom fieldpost
List custom fieldsget
Create custom fieldpost
Custom field object
Payment retry rules
Retrieve payment retry ruleget
List payment retry rulesget
Payment retry rule object
Bank code lookup
Bank code lookuppost
Bank code lookup overview
Health check
Check platform healthget

Files
Files
Download fileget
Retrieve fileget
List filesget
Cancel filepost
Approve filepost
File lifecycle
File object

Events
Events
Resend eventpost
Retrieve eventget
List eventsget
Retry failed eventspost
Event lifecycle
Event object

Additional resources
Account verification
Account details
Address
Payment methods supported

Numeral API
Getting started
Environments
Authentication
Sign API requests
Webhooks
Verify webhooks
Idempotency
API versioning
Status codes
Rate limiting
Data types
Currency codes and digits
Pagination
Metadata
Reason codes
FPS reason codes
Bacs reason codes
SEPA reason codes
Purpose codes

Payments
Payment orders
Retrieve payment orderget
Update payment orderpost
Retry payment orderpost
Cancel payment orderpost
Approve payment orderpost
List payment ordersget
Create payment orderpost
Payment order lifecycle
Payment order object
Incoming payments
List incoming paymentsget
Retrieve incoming paymentget
Update incoming paymentpost
Reject incoming paymentpost
Confirm incoming paymentpost
Incoming payment lifecycle
Incoming payment object
Returns
Cancel returnpost
Approve returnpost
Retrieve returnget
List returnsget
Create returnpost
Return lifecycle
Return object

Investigations
Return requests
Retrieve return requestget
Deny return requestpost
Accept return requestpost
List return requestsget
Create return requestpost
Return request lifecycle
Return request object
Claims
Retrieve claimget
List claimsget
Create claimpost
Claim lifecycle
Claim object
Inquiries
Retrieve inquiryget
List inquiriesget
Create inquirypost
Inquiry lifecycle
Deny inquirypost
Inquiry object

Accounts
Connected accounts
Retrieve connected accountget
List connected accountsget
Connected account object
Transactions
Retrieve transactionget
Update transactionpost
List transactionsget
Transaction lifecycle
Transaction object
Balances
Retrieve balanceget
List balancesget
Balance lifecycle
Balance object

Counterparties
Counterparties
Retrieve counterpartyget
Update counterpartypost
Disable counterpartypost
List counterpartiesget
Create counterpartypost
Counterparty lifecycle
Counterparty object
Counterparty accounts
Retrieve counterparty accountget
Update counterparty accountpost
Verify counterparty accountpost
Disable counterparty accountpost
Deny counterparty accountpost
Approve counterparty accountpost
List counterparty accountsget
Create counterparty accountpost
Counterparty account lifecycle
Counterparty account object
Virtual accounts
Retrieve virtual accountget
Update virtual accountpost
Disable virtual accountpost
Unassign virtual account from counterpartypost
Assign virtual account to counterpartypost
List virtual accountsget
Create virtual accountpost
Virtual account lifecycle
Virtual account object
Account holders
Retrieve account holderget
Update account holderpost
Disable account holderpost
List account holdersget
Create account holderpost
Account holder lifecycle
Account holder object
External accounts
Retrieve external accountget
Update external accountpost
Verify external accountpost
Disable external accountpost
Deny external accountpost
Approve external accountpost
List external accountsget
Create external accountpost
External account lifecycle
External account object
Internal accounts
Retrieve internal accountget
Disable internal accountpost
Unblock internal accountpost
Block internal accountpost
List internal accountsget
Create internal accountpost
Internal account lifecycle
Internal account object
Direct debit mandates
Authorize direct debit mandatepost
Block direct debit mandatepost
Disable direct debit mandatepost
Retrieve direct debit mandateget
Update direct debit mandatepost
List direct debit mandatesget
Create direct debit mandatepost
Direct debit mandate lifecycle
Direct debit mandate object

Reconciliations
Expected payments
Retrieve expected paymentget
Update expected paymentpost
Cancel expected paymentpost
List expected paymentsget
Create expected paymentpost
Expected payment lifecycle
Expected payment object
Payment captures
Retrieve payment captureget
Update payment capturepost
Cancel payment capturepost
List payment capturesget
Create payment capturepost
Payment capture lifecycle
Payment capture object
Reconciliations
Retrieve reconciliationget
Update reconciliationpost
Cancel reconciliationpost
List reconciliationsget
Create reconciliationpost
Reconciliation lifecycle
Reconciliation object

Verification of Payee
Payee verification requests
Simulate incoming payee verification requestpost
Retrieve payee verification requestget
List payee verification requestsget
Send verification payee requestpost
Payee verification request lifecycle
Payee verification request object
Verification scheme participants
Retrieve verification scheme participantget
Get supported identification types for a payee accountget

Tools
Process payments
Process paymentspost
Bulk actions
Retrieve bulk action related itemsget
Retrieve bulk actionget
List bulk actionsget
Create bulk actionpost
Bulk action lifecycle
Bulk action object
Custom fields
Retrieve custom fieldget
Update custom fieldpost
List custom fieldsget
Create custom fieldpost
Custom field object
Payment retry rules
Retrieve payment retry ruleget
List payment retry rulesget
Payment retry rule object
Bank code lookup
Bank code lookuppost
Bank code lookup overview
Health check
Check platform healthget

Files
Files
Download fileget
Retrieve fileget
List filesget
Cancel filepost
Approve filepost
File lifecycle
File object

Events
Events
Resend eventpost
Retrieve eventget
List eventsget
Retry failed eventspost
Event lifecycle
Event object

Additional resources
Account verification
Account details
Address
Payment methods supported

200200

400400