Getting Started
Account Management
SEPA Instant
SEPA Direct Debit
SWIFT Payments
Payment Information
Nostro Accounts
Bank Information
curl --request GET \
--url https://api.pgw-sandbox.finventi.com/v1/transactions/{id}/payment-return{
"result": {
"cr_amount": 123,
"cr_ccy_isocode": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"dr_amount": 123,
"dr_ccy_isocode": "<string>",
"id": 123,
"status": "<string>",
"status_hardvalue": "<string>",
"status_id": 123,
"type": "<string>",
"type_id": 123,
"compensation_amt": 123,
"inbound": {
"cr_acc": "<string>",
"cr_amount": 123,
"cr_bank_bic": "<string>",
"cr_ccy_isocode": "<string>",
"cr_name": "<string>",
"dr_acc": "<string>",
"dr_bank_bic": "<string>",
"dr_name": "<string>",
"id": 123,
"sepa_msg_id": "<string>",
"status": "<string>",
"cr_address": "<string>",
"cr_address_city": "<string>",
"cr_address_country": "<string>",
"cr_alt_code_company": "<string>",
"cr_alt_code_company_issuer": "<string>",
"cr_bank_name": "<string>",
"cr_code_company": "<string>",
"cr_code_issuer": "<string>",
"cr_code_person": "<string>",
"dr_address": "<string>",
"dr_address_city": "<string>",
"dr_address_country": "<string>",
"dr_alt_code_company": "<string>",
"dr_alt_code_company_issuer": "<string>",
"dr_bank_name": "<string>",
"dr_code_company": "<string>",
"dr_code_issuer": "<string>",
"dr_code_person": "<string>",
"end_to_end_id": "<string>",
"method": "SEPA",
"settlement_date": "2023-12-25",
"trx_purpose": "<string>",
"trx_purpose_information": "<string>",
"trx_purpose_structured_issuer": "<string>",
"trx_purpose_structured_ref": "<string>",
"ucr_address": "<string>",
"ucr_address_city": "<string>",
"ucr_address_country": "<string>",
"ucr_id_type": 123,
"ucr_identification": "<string>",
"ucr_issuer": "<string>",
"ucr_name": "<string>",
"ucr_organisation_bic": "<string>",
"ucr_private_birth": "<string>",
"ucr_private_birth_city": "<string>",
"ucr_private_birth_country": "<string>",
"ucr_private_birth_province": "<string>",
"ucr_scheme_code": "<string>",
"ucr_scheme_proprietary": "<string>",
"udr_address": "<string>",
"udr_address_city": "<string>",
"udr_address_country": "<string>",
"udr_id_type": 123,
"udr_identification": "<string>",
"udr_issuer": "<string>",
"udr_name": "<string>",
"udr_organisation_bic": "<string>",
"udr_private_birth": "<string>",
"udr_private_birth_city": "<string>",
"udr_private_birth_country": "<string>",
"udr_private_birth_province": "<string>",
"udr_scheme_code": "<string>",
"udr_scheme_proprietary": "<string>"
},
"mandate_information": {
"date_of_signature": "2023-12-25",
"id": "<string>"
},
"origin_bic": "<string>",
"origin_name": "<string>",
"origin_reason_code": "<string>",
"origin_reason_info": "<string>",
"outbound": {
"cr_acc": "<string>",
"cr_bank_bic": "<string>",
"cr_name": "<string>",
"dr_acc": "<string>",
"dr_amount": 123,
"dr_bank_bic": "<string>",
"dr_ccy_isocode": "<string>",
"dr_name": "<string>",
"id": 123,
"sepa_msg_id": "<string>",
"status": "<string>",
"cr_address": "<string>",
"cr_address_city": "<string>",
"cr_address_country": "<string>",
"cr_alt_code_company": "<string>",
"cr_alt_code_company_issuer": "<string>",
"cr_bank_name": "<string>",
"cr_code_company": "<string>",
"cr_code_issuer": "<string>",
"cr_code_person": "<string>",
"dr_address": "<string>",
"dr_address_city": "<string>",
"dr_address_country": "<string>",
"dr_alt_code_company": "<string>",
"dr_alt_code_company_issuer": "<string>",
"dr_bank_name": "<string>",
"dr_code_company": "<string>",
"dr_code_issuer": "<string>",
"dr_code_person": "<string>",
"end_to_end_id": "<string>",
"method": "SEPA",
"settlement_date": "2023-12-25",
"trx_purpose": "<string>",
"trx_purpose_information": "<string>",
"trx_purpose_structured_issuer": "<string>",
"trx_purpose_structured_ref": "<string>",
"ucr_address": "<string>",
"ucr_address_city": "<string>",
"ucr_address_country": "<string>",
"ucr_id_type": 123,
"ucr_identification": "<string>",
"ucr_issuer": "<string>",
"ucr_name": "<string>",
"ucr_organisation_bic": "<string>",
"ucr_private_birth": "<string>",
"ucr_private_birth_city": "<string>",
"ucr_private_birth_country": "<string>",
"ucr_private_birth_province": "<string>",
"ucr_scheme_code": "<string>",
"ucr_scheme_proprietary": "<string>",
"udr_address": "<string>",
"udr_address_city": "<string>",
"udr_address_country": "<string>",
"udr_id_type": 123,
"udr_identification": "<string>",
"udr_issuer": "<string>",
"udr_name": "<string>",
"udr_organisation_bic": "<string>",
"udr_private_birth": "<string>",
"udr_private_birth_city": "<string>",
"udr_private_birth_country": "<string>",
"udr_private_birth_province": "<string>",
"udr_scheme_code": "<string>",
"udr_scheme_proprietary": "<string>"
},
"parent_trx_amt": 123,
"parent_trx_id": 123,
"rtrn_chrgs_amt": 123,
"sepa_trx_id": "<string>",
"sequence_type": "FRST",
"status_reason": "<string>",
"unaccounted_tax_amt": 123,
"updated_at": "2023-11-07T05:31:56Z"
}
}Get active payment return details
Retrieves details of active payment returns.
curl --request GET \
--url https://api.pgw-sandbox.finventi.com/v1/transactions/{id}/payment-return{
"result": {
"cr_amount": 123,
"cr_ccy_isocode": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"dr_amount": 123,
"dr_ccy_isocode": "<string>",
"id": 123,
"status": "<string>",
"status_hardvalue": "<string>",
"status_id": 123,
"type": "<string>",
"type_id": 123,
"compensation_amt": 123,
"inbound": {
"cr_acc": "<string>",
"cr_amount": 123,
"cr_bank_bic": "<string>",
"cr_ccy_isocode": "<string>",
"cr_name": "<string>",
"dr_acc": "<string>",
"dr_bank_bic": "<string>",
"dr_name": "<string>",
"id": 123,
"sepa_msg_id": "<string>",
"status": "<string>",
"cr_address": "<string>",
"cr_address_city": "<string>",
"cr_address_country": "<string>",
"cr_alt_code_company": "<string>",
"cr_alt_code_company_issuer": "<string>",
"cr_bank_name": "<string>",
"cr_code_company": "<string>",
"cr_code_issuer": "<string>",
"cr_code_person": "<string>",
"dr_address": "<string>",
"dr_address_city": "<string>",
"dr_address_country": "<string>",
"dr_alt_code_company": "<string>",
"dr_alt_code_company_issuer": "<string>",
"dr_bank_name": "<string>",
"dr_code_company": "<string>",
"dr_code_issuer": "<string>",
"dr_code_person": "<string>",
"end_to_end_id": "<string>",
"method": "SEPA",
"settlement_date": "2023-12-25",
"trx_purpose": "<string>",
"trx_purpose_information": "<string>",
"trx_purpose_structured_issuer": "<string>",
"trx_purpose_structured_ref": "<string>",
"ucr_address": "<string>",
"ucr_address_city": "<string>",
"ucr_address_country": "<string>",
"ucr_id_type": 123,
"ucr_identification": "<string>",
"ucr_issuer": "<string>",
"ucr_name": "<string>",
"ucr_organisation_bic": "<string>",
"ucr_private_birth": "<string>",
"ucr_private_birth_city": "<string>",
"ucr_private_birth_country": "<string>",
"ucr_private_birth_province": "<string>",
"ucr_scheme_code": "<string>",
"ucr_scheme_proprietary": "<string>",
"udr_address": "<string>",
"udr_address_city": "<string>",
"udr_address_country": "<string>",
"udr_id_type": 123,
"udr_identification": "<string>",
"udr_issuer": "<string>",
"udr_name": "<string>",
"udr_organisation_bic": "<string>",
"udr_private_birth": "<string>",
"udr_private_birth_city": "<string>",
"udr_private_birth_country": "<string>",
"udr_private_birth_province": "<string>",
"udr_scheme_code": "<string>",
"udr_scheme_proprietary": "<string>"
},
"mandate_information": {
"date_of_signature": "2023-12-25",
"id": "<string>"
},
"origin_bic": "<string>",
"origin_name": "<string>",
"origin_reason_code": "<string>",
"origin_reason_info": "<string>",
"outbound": {
"cr_acc": "<string>",
"cr_bank_bic": "<string>",
"cr_name": "<string>",
"dr_acc": "<string>",
"dr_amount": 123,
"dr_bank_bic": "<string>",
"dr_ccy_isocode": "<string>",
"dr_name": "<string>",
"id": 123,
"sepa_msg_id": "<string>",
"status": "<string>",
"cr_address": "<string>",
"cr_address_city": "<string>",
"cr_address_country": "<string>",
"cr_alt_code_company": "<string>",
"cr_alt_code_company_issuer": "<string>",
"cr_bank_name": "<string>",
"cr_code_company": "<string>",
"cr_code_issuer": "<string>",
"cr_code_person": "<string>",
"dr_address": "<string>",
"dr_address_city": "<string>",
"dr_address_country": "<string>",
"dr_alt_code_company": "<string>",
"dr_alt_code_company_issuer": "<string>",
"dr_bank_name": "<string>",
"dr_code_company": "<string>",
"dr_code_issuer": "<string>",
"dr_code_person": "<string>",
"end_to_end_id": "<string>",
"method": "SEPA",
"settlement_date": "2023-12-25",
"trx_purpose": "<string>",
"trx_purpose_information": "<string>",
"trx_purpose_structured_issuer": "<string>",
"trx_purpose_structured_ref": "<string>",
"ucr_address": "<string>",
"ucr_address_city": "<string>",
"ucr_address_country": "<string>",
"ucr_id_type": 123,
"ucr_identification": "<string>",
"ucr_issuer": "<string>",
"ucr_name": "<string>",
"ucr_organisation_bic": "<string>",
"ucr_private_birth": "<string>",
"ucr_private_birth_city": "<string>",
"ucr_private_birth_country": "<string>",
"ucr_private_birth_province": "<string>",
"ucr_scheme_code": "<string>",
"ucr_scheme_proprietary": "<string>",
"udr_address": "<string>",
"udr_address_city": "<string>",
"udr_address_country": "<string>",
"udr_id_type": 123,
"udr_identification": "<string>",
"udr_issuer": "<string>",
"udr_name": "<string>",
"udr_organisation_bic": "<string>",
"udr_private_birth": "<string>",
"udr_private_birth_city": "<string>",
"udr_private_birth_country": "<string>",
"udr_private_birth_province": "<string>",
"udr_scheme_code": "<string>",
"udr_scheme_proprietary": "<string>"
},
"parent_trx_amt": 123,
"parent_trx_id": 123,
"rtrn_chrgs_amt": 123,
"sepa_trx_id": "<string>",
"sequence_type": "FRST",
"status_reason": "<string>",
"unaccounted_tax_amt": 123,
"updated_at": "2023-11-07T05:31:56Z"
}
}Path Parameters
Transaction ID
Response
Retrieved details of payment return
Show child attributes
Show child attributes
Payment amount in minor currency units (cents)
SEPA payment currency code
Time and date when transaction was created
Payment amount in minor currency units (cents)
SEPA payment currency code
Transaction ID
Name of the status
Hard value of status
Status id, all statuses can be retrived using API getTransactionStatuses
Type name
Type id, all transaction types can be retrieved using API getTransactionTypes
Payment compensation amount
Information about inbound transaction
Show child attributes
Show child attributes
Creditor (Recipient) Account (IBAN)
Creditor amount in minor currency units (cents)
Creditor (Recipient) Bank Code - BIC
SEPA payment currency code
Creditor (Recipient) Name
Debtor (Sender) Account (IBAN)
Debtor (Sender) Bank Code - BIC
Debtor (Sender) Name
Outbound transaction id
Sepa message id
3rd party status
Creditor address
Creditor city
Creditor country
Alternative Creditor company code
Alternative Creditor company code issuer
Creditor bank name
Creditor company code
Issuer of Creditor company/person code
Creditor Personal code
Debtor address
Debtor city
Debtor country
Alternative Debtor company code
Alternative Debtor company code issuer
Debtor bank name
Debtor company code
Issuer of Debtor company/person code
Debtor Personal code
End to end id for transaction
Transaction method
SEPA, INST, SDD, SWIFT Transaction settlement date
Unstructured payment purpose (free text)
Category purpose Code, 'ADVA' - Advance Payment, 'TAXS' - Tax Payment
Structured reference code issuer
Structured reference code
Ultimate Creditor Address
Ultimate Creditor City
Ultimate Creditor Country
Ultimate Creditor Identification type, '1' for Company clients, '2' for Person clients
Other identification code for company or person
Identification code issuer
Ultimate Creditor Name
BIC or BEI identification code
Persons date of birth
Persons birth city
Persons birth country
Persons birth province
Please refer to the to the External code sets for the supported codes list and their description
Identification code type as free text
Ultimate Debtor Address
Ultimate Debtor City
Ultimate Debtor Country
Ultimate Debtor Identification type, '1' for Company clients, '2' for Person clients
Other identification code for company or person
Identification code issuer
Ultimate Debtor Name
BIC or BEI identification code
Persons date of birth
Persons birth city
Persons birth country
Persons birth province
Please refer to the to the External code sets for the supported codes list and their description
Identification code type as free text
Provides further details of the direct debit mandate signed between the creditor and the debtor.
Payment return originator bic
Payment return originator name
Payment return originator reason code
Payment return originator reason information
Information about outbound transaction
Show child attributes
Show child attributes
Creditor (Recipient) Account (IBAN)
Creditor (Recipient) Bank Code - BIC
Creditor (Recipient) Name
Debtor (Sender) Account (IBAN)
Payment amount in minor currency units (cents)
Debtor (Sender) Bank Code - BIC
SEPA payment currency code
Debtor (Sender) Name
Outbound transaction id
Sepa message id
3rd party status
Creditor address
Creditor city
Creditor country
Alternative Creditor company code
Alternative Creditor company code issuer
Creditor bank name
Creditor company code
Issuer of Creditor company/person code
Creditor Personal code
Debtor address
Debtor city
Debtor country
Alternative Debtor company code
Alternative Debtor company code issuer
Debtor bank name
Debtor company code
Issuer of Debtor company/person code
Debtor Personal code
End to end id for transaction
Transaction method
SEPA, INST, SDD, SWIFT Transaction settlement date
Unstructured payment purpose (free text)
Category purpose Code, 'ADVA' - Advance Payment, 'TAXS' - Tax Payment
Structured reference code issuer
Structured reference code
Ultimate Creditor Address
Ultimate Creditor City
Ultimate Creditor Country
Ultimate Creditor Identification type, '1' for Company clients, '2' for Person clients
Other identification code for company or person
Identification code issuer
Ultimate Creditor Name
BIC or BEI identification code
Persons date of birth
Persons birth city
Persons birth country
Persons birth province
Please refer to the to the External code sets for the supported codes list and their description
Identification code type as free text
Ultimate Debtor Address
Ultimate Debtor City
Ultimate Debtor Country
Ultimate Debtor Identification type, '1' for Company clients, '2' for Person clients
Other identification code for company or person
Identification code issuer
Ultimate Debtor Name
BIC or BEI identification code
Persons date of birth
Persons birth city
Persons birth country
Persons birth province
Please refer to the to the External code sets for the supported codes list and their description
Identification code type as free text
Original transaction amount
Transaction id for parent transaction
Payment return tax amount
Sepa transaction ID
Identifies the direct debit sequence, such as first, recurrent, final or one-off.
FRST, RCUR, FNAL, OOFF If there is some error, it is displayed in status reason or processing info tags
Payment unaccounted tax amount
Time and date when transaction was last updated