Corgi BankDocumentation
OpenAPI

Receive a message the SWIFT network (the simulator) delivers: pacs.008, pacs.009 (core or cover), pacs.004, pacs.002, camt.056 or camt.029 under head.001.001.02

POST/rails/swift/inbound

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Returns

200 OK

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

Errors

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

400401403404409412413422424429500503

to move to open esc to close