0% found this document useful (0 votes)
756 views6 pages

Create Payment via Oracle REST API

The document provides instructions for creating a payment using the Oracle Fusion Cloud REST API. It describes filling out a payment request payload with fields like payment number, date, description, currency, payee, bank account, invoices, and payment method. It also covers authenticating the request, sending it to the REST endpoint, and checking the response and payment status in the user interface.

Uploaded by

Osman Farooq
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
756 views6 pages

Create Payment via Oracle REST API

The document provides instructions for creating a payment using the Oracle Fusion Cloud REST API. It describes filling out a payment request payload with fields like payment number, date, description, currency, payee, bank account, invoices, and payment method. It also covers authenticating the request, sending it to the REST endpoint, and checking the response and payment status in the user interface.

Uploaded by

Osman Farooq
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
  • Create Payment using REST API
  • REST API Integration with Postman

Create Payment using REST API

Create Invoice and make sure is Validated and approved if necessary.

Check Installments and make sure the Payment Method and Bank Account
Open Postman

Add the URL for POST Method

[Link]

And the Authorization

Header parameter Content-Type to be added


Fill the Body of the Payload and click on Send

Example here:

"PaymentNumber": 1006,

"PaymentDate": "2019-08-02",

"PaymentDescription": "BB_PAY_REST_API1",

"PaymentType": "Manual",

"PaymentCurrency": "USD",

"BusinessUnit": "Vision Operations",

"Payee": "Advanced Network Devices",


"PayeeSite": "FRESNO",

"DisbursementBankAccountName": "BofA-204",

"PaymentMethod": "Check",

"PaymentProcessProfile": "Standard Check",

"PaymentDocument": "AP Standard Check Format 2",

"relatedInvoices": [

"InvoiceNumber": "BB_PAY_REST_API1",

"InstallmentNumber": 1,

"AmountPaidPaymentCurrency": 124.32

Check response. In this case is successful

CheckId is provided along with the other information


Check in UI Payments status

Go to Manage Payments and search using Payment Number

Common questions

Powered by AI

The 'PaymentProcessProfile' enhances the processing of payments by defining a set of rules and procedures associated with executing payments. It dictates how the payment is managed through various stages including validation, approval, formatting, and actual disbursement. By using a predefined 'PaymentProcessProfile', organizations can streamline payment processes, maintain consistency, and comply with internal controls and external regulations .

Specifying both 'PaymentMethod' and 'DisbursementBankAccountName' is significant because they define how and where the payment will be processed and settled. 'PaymentMethod' determines the type of payment vehicle, such as a check or electronic transfer, while 'DisbursementBankAccountName' specifies the bank account from which the funds will be disbursed. Correct pairing of these fields ensures appropriate handling of the payment, aligning it with organizational policies and financial protocols .

The successful implementation of a REST API for payment creation can significantly enhance business processes and efficiency by automating and streamlining transactions, minimizing manual errors, and reducing processing time. It facilitates real-time integration with financial systems, allowing for immediate updates and reconciliations. This leads to improved operational agility, faster transaction cycles, and better resource allocation, thereby positively impacting overall business productivity and financial accuracy .

When creating a payment using the REST API, the Authorization and Content-Type header parameters must be correctly configured. The Authorization header is necessary to authenticate the API request, ensuring that the requester has the proper permissions to perform the transaction. The Content-Type parameter, typically 'application/json', informs the server of the payload type being sent, ensuring that it is processed correctly .

Incomplete or incorrect information in the payment payload can significantly disrupt the payment transaction process by causing validation errors, mismatched records, or incorrect disbursements. This could lead to payment failures, delays, or errors in financial reporting. It is critical to ensure all required fields, such as PaymentNumber, PaymentDate, and related invoices, are accurately completed to avoid transaction issues and ensure compliance with financial controls .

'PaymentDocument' specifies the format and template used for physical or electronic payment records, such as checks or remittance advices. Its role is crucial in ensuring that payments are documented in a manner compliant with organizational and legal standards, facilitating both internal auditing and external validations. By defining this parameter, businesses ensure clarity and consistency in payment communications .

Insufficient error handling and feedback in the REST API for payment creation could lead to undetected transaction failures, unresolved issues, and financial discrepancies. Without proper error messages or response codes, troubleshooting becomes difficult, increasing operational costs and time. Errors may propagate into financial reporting, affecting decision-making and regulatory compliance. Hence, robust error handling is critical for maintaining transaction reliability and integrity .

The 'relatedInvoices' section in the payment creation payload is crucial as it links the payment to specific invoices. Each entry within 'relatedInvoices' specifies details such as the InvoiceNumber, InstallmentNumber, and AmountPaidPaymentCurrency, thereby ensuring the payment is correctly applied to the appropriate invoice or installment. This linkage is fundamental for maintaining accurate financial records and ensuring that payments are matched with their corresponding obligations .

To confirm the success of a payment creation request using the REST API, follow these steps: check the API response for success indicators such as a CheckId, verify the payment details in the response, and then check the UI for payment status updates using the Payment Number. Each step is important as it ensures that the payment was processed correctly and reconciles both API responses and system records, thus preventing issues like unrecorded payments or incorrect ledger entries .

Checking the payment status in the UI after creating a payment through the REST API is essential to ensure the transaction was processed correctly and reflects accurately in the financial system. If discrepancies are found, such as mismatches in payment amounts or status, it is important to first verify the payload sent and the response received. If the issue persists, one should consult system logs and possibly retry the operation, or seek assistance from technical support to resolve any underlying issues within the API or UI .

Create Payment using REST API
Create Invoice and make sure is Validated and approved if necessary.
Check Installments and mak
Open Postman
Add the URL for POST Method
https://zboh.fa.dc1.c9dev2.oraclecorp.com/fscmRestApi/resources/11.13.18.05/payables
Fill the Body of the Payload and click on Send
Example here:
{
"PaymentNumber": 1006,
"PaymentDate": "2019-08-02",
"PaymentDe
"PayeeSite": "FRESNO",
"DisbursementBankAccountName": "BofA-204",
"PaymentMethod": "Check",
"PaymentProcessProfile": "Standar
Check in UI Payments status
Go to Manage Payments and search using Payment Number

You might also like