In this FAQ, we address common questions about handling source account details and references within Token.io's SDK for Coop. These insights will help you navigate the API interactions, ensuring a smooth integration process and a better understanding of how different fields are managed in various scenarios.
Q1: Are we required to pass the source account details to Token in the Create Consent API, even if it was pre-selected in the Get Consent API response?
A1: Yes, you need to pass the source account details in the Create Consent API. This ensures Token knows which account the consent is meant for.
Q2: What happens if we don't pass the source account details to Token in the Create Consent API?
A2: If you don't pass the source account details, the consent creation will not proceed correctly, as Token requires this information to identify the relevant account.
Q3: How do logs track API access to ensure accurate attack tracing?
A3: Token logs record all API calls made by the TPP.
Q4: Is the testing environment segregated from the production environment?
A4: Yes, the testing environment is segregated from the production environment with robust access controls to ensure separation.
Q5: In which API requests is the POST /transfers endpoint used?
A5:
- POST /transfers: Used for createTransfer.
- POST /standing-order-submissions: Used for createStandingOrder.
- POST /bulk-transfers: Used for createBulkTransfer.
Q6: How does the remittanceReference field appear in different API requests and responses?
A6: The remittanceReference field appears differently based on the type of request:
- For Transfers: Passed in the `consentRequest.getTransferBody().getRemittanceReference()` field.
- For Standing Orders: Passed in the `consentRequest.getStandingOrderBody().getRemittanceReference()` field.
- For Bulk Transfers: Not applicable, use `consentRequest.bulkTransferBody.transfers.0.description` instead.
Q7: Is the remittanceReference field included in bulkTransferBody?
A7: No, bulkTransferBody does not include the remittanceReference field. Instead, it includes descriptions for each transfer.
Q8: Can we expect both description and remittanceReference fields to be populated in a bulk transfer?
A8: For bulk transfers, both `consentRequest.description` and `consentRequest.bulkTransferBody.transfers.0.description` can be populated but are not required fields.
Q9: What is the difference between refId and remittanceReference fields?
A9:
- refId (ReferenceId): Typically a system-generated ID, used as the OBIE EndToEndIdentification and InstructionIdentification fields.
- remittanceReference: Contains a string the creditor will recognise, equivalent to the OBIE RemittanceInformation Structured field.
- Description: A human-readable text describing the payment, equivalent to the OBIE RemittanceInformation Unstructured field.
Q10: How do the remittanceReference and description fields get populated?
A10:
- remittanceReference: Likely a randomly generated ID, not typically shared with the user.
- Description: Contains text like "Lunch payment" provided by the user.
Q11: How is a customer-provided reference like 'Lunch payment' treated in terms of remittanceReference and refId?
A11:
- refId: Contains a system-generated ID.
- remittanceReference: Contains the customer-provided reference, like 'Lunch payment'.
These FAQs should help in understanding how to work with source account details, remittance references, and other related fields within Token.io's SDK for Coop.
If further questions arise, please refer to our documentation.