Corgi BankDocumentation
OpenAPI

A SWIFT repair with its maker-checker record

GET/rails/swift/repairs/{id}

Path parameters

idstringRequired

Returns

200 OK

cancellationobject or nullOptional

SwiftCancellation is a cancellation case (camt.056 and its camt.029).

17 child attributes
assignment_idstringRequired
case_idstringRequired

Example case_2tVh8nqLxq4GbDe0K1F6S9zRcWm

counterparty_bicstringRequired
created_atstring · date-timeRequired
directionstringRequired
idstringRequired
network_refstringOptional
payment_idstringRequired

Example lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm

reasonstringOptional
reason_codestringRequired
requested_bystringRequired
resolutionstringOptional
resolution_reasonstringOptional
resolution_reason_codestringOptional
return_payment_idstringOptional

Example lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm

statusstringRequired
updated_atstring · date-timeRequired
decisionsarray of objectsRequired
6 child attributes
actionstringRequired
actorstringRequired
eventstringRequired

Proposed, approved, rejected, executed or failed

outcomestringOptional
proposalobjectRequired
recorded_atstring · date-timeRequired
paymentobject or nullOptional

SwiftPayment is a SWIFT payment in either direction: a customer transfer, a bank transfer or a return.

57 child attributes
account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

The instructed amount

approved_bystringOptional
charge_bearerstringOptional
correspondent_bicstringOptional

The next agent outbound, the previous one inbound

cover_bicstringOptional
cover_msg_idstringOptional
cover_network_refstringOptional
cover_network_statusstringOptional
created_atstring · date-timeRequired
creditorobjectRequired

Party is a debtor, creditor or ultimate party: a name and address, or a BIC, with an account and further identification. The Travel Rule (31 CFR 1010.410(f)) data of a transmittal of funds travels in these fields.

9 child attributes
accountstringOptional

An IBAN when its check digits pass, another identifier otherwise

addressobjectRequired

Address is a postal address in the elements of PostalAddress24.

15 child attributes
building_namestringOptional
building_numberstringOptional
countrystringOptional
country_sub_divisionstringOptional
departmentstringOptional
district_namestringOptional
floorstringOptional
linesarray of stringsOptional
post_boxstringOptional
post_codestringOptional
roomstringOptional
street_namestringOptional
sub_departmentstringOptional
town_location_namestringOptional
town_namestringOptional
any_bicstringOptional
country_of_residencestringOptional
leistringOptional
namestringOptional
other_idstringOptional
other_id_schemestringOptional

ExternalOrganisationIdentification1Code or ExternalPersonIdentification1Code

privatebooleanOptional

The other identification is a person's (PrvtId), not an organisation's

creditor_agent_bicstringOptional
currency_codestringRequired
customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

debit_amountintegerOptional

Outbound: the amount, the bank's fee and prepaid charges

debtorobjectRequired

Party is a debtor, creditor or ultimate party: a name and address, or a BIC, with an account and further identification. The Travel Rule (31 CFR 1010.410(f)) data of a transmittal of funds travels in these fields.

9 child attributes
accountstringOptional

An IBAN when its check digits pass, another identifier otherwise

addressobjectRequired

Address is a postal address in the elements of PostalAddress24.

15 child attributes
building_namestringOptional
building_numberstringOptional
countrystringOptional
country_sub_divisionstringOptional
departmentstringOptional
district_namestringOptional
floorstringOptional
linesarray of stringsOptional
post_boxstringOptional
post_codestringOptional
roomstringOptional
street_namestringOptional
sub_departmentstringOptional
town_location_namestringOptional
town_namestringOptional
any_bicstringOptional
country_of_residencestringOptional
leistringOptional
namestringOptional
other_idstringOptional
other_id_schemestringOptional

ExternalOrganisationIdentification1Code or ExternalPersonIdentification1Code

privatebooleanOptional

The other identification is a person's (PrvtId), not an organisation's

debtor_agent_bicstringOptional
deducted_charges_amountintegerOptional
directionstringRequired

Outbound or inbound

end_to_end_idstringOptional
fee_amountintegerOptional
fx_quote_idstringOptional
gl_codestringOptional
hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired
instr_idstringOptional
intermediary_bicstringOptional
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

Customer, bank or return

ledger_account_idstringOptional

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

msg_idstringOptional
network_refstringOptional
network_statusstringOptional
operatorstringOptional
original_payment_idstringOptional

Example lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm

prepaid_charges_amountintegerOptional
purposestringOptional
queued_untilstring · date-time or nullOptional
reasonstringOptional
remittancestringOptional
repair_idstringOptional
return_reasonstringOptional
return_reason_codestringOptional
returned_amountintegerOptional
reversal_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

screening_idstringOptional

Example scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm

screening_resultstringOptional
settlement_amountintegerRequired
settlement_methodstringOptional

INDA, INGA or COVE

statusstringRequired

Received, held_for_review, queued, sending, sent, completed, repair, rejected, returned, cancelled, credited or blocked

tracker_reasonstringOptional
tracker_statusstringOptional
uetrstringRequired
ultimate_creditorobjectRequired

Party is a debtor, creditor or ultimate party: a name and address, or a BIC, with an account and further identification. The Travel Rule (31 CFR 1010.410(f)) data of a transmittal of funds travels in these fields.

9 child attributes
accountstringOptional

An IBAN when its check digits pass, another identifier otherwise

addressobjectRequired

Address is a postal address in the elements of PostalAddress24.

15 child attributes
building_namestringOptional
building_numberstringOptional
countrystringOptional
country_sub_divisionstringOptional
departmentstringOptional
district_namestringOptional
floorstringOptional
linesarray of stringsOptional
post_boxstringOptional
post_codestringOptional
roomstringOptional
street_namestringOptional
sub_departmentstringOptional
town_location_namestringOptional
town_namestringOptional
any_bicstringOptional
country_of_residencestringOptional
leistringOptional
namestringOptional
other_idstringOptional
other_id_schemestringOptional

ExternalOrganisationIdentification1Code or ExternalPersonIdentification1Code

privatebooleanOptional

The other identification is a person's (PrvtId), not an organisation's

ultimate_debtorobjectRequired

Party is a debtor, creditor or ultimate party: a name and address, or a BIC, with an account and further identification. The Travel Rule (31 CFR 1010.410(f)) data of a transmittal of funds travels in these fields.

9 child attributes
accountstringOptional

An IBAN when its check digits pass, another identifier otherwise

addressobjectRequired

Address is a postal address in the elements of PostalAddress24.

15 child attributes
building_namestringOptional
building_numberstringOptional
countrystringOptional
country_sub_divisionstringOptional
departmentstringOptional
district_namestringOptional
floorstringOptional
linesarray of stringsOptional
post_boxstringOptional
post_codestringOptional
roomstringOptional
street_namestringOptional
sub_departmentstringOptional
town_location_namestringOptional
town_namestringOptional
any_bicstringOptional
country_of_residencestringOptional
leistringOptional
namestringOptional
other_idstringOptional
other_id_schemestringOptional

ExternalOrganisationIdentification1Code or ExternalPersonIdentification1Code

privatebooleanOptional

The other identification is a person's (PrvtId), not an organisation's

updated_atstring · date-timeRequired
value_datestring · date or nullOptional

A business date, YYYY-MM-DD

repairobjectRequired

SwiftRepair is an item in the SWIFT repair queue.

14 child attributes
actionsarray of stringsRequired
cancellation_idstringOptional
created_atstring · date-timeRequired
decided_atstring · date-time or nullOptional
decided_bystringOptional
idstringRequired
kindstringRequired
outcomestringOptional
payment_idstringOptional

Example lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm

proposalobject or nullOptional

SwiftRepairProposal is a maker's proposed decision on a repair.

10 child attributes
account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

actionstringRequired
amountintegerOptional
correctionsobject or nullOptional

SwiftCorrections are what a resend from the repair queue may correct.

3 child attributes
creditorobject or nullOptional

Party is a debtor, creditor or ultimate party: a name and address, or a BIC, with an account and further identification. The Travel Rule (31 CFR 1010.410(f)) data of a transmittal of funds travels in these fields.

creditor_agent_bicstringOptional
remittancestring or nullOptional
gl_codestringOptional
makerstringRequired
notestringOptional
proposed_atstring · date-timeRequired
reasonstringOptional
reason_codestringOptional
reasonstringRequired
statusstringRequired

Open, proposed, executing or resolved

updated_atstring · date-timeRequired
violationsarray of objectsOptional
3 child attributes
detailstringRequired
elementstringRequired
rulestringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close