Custom Payment Method

Git RepositoryEdit on Github
Last update: 2 years ago by luigi mangaReading time: 2 min

When integrating with a custom payment method to transfer funds to vendors, it may be needed to process payments from an external system and update Onport about the status.

The first step is to look up the payment transfers via the API call below:

curl --request GET \
--url \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

The querystring can be customized to filter by dropshipProviderId via transfers.json?where[dropshipProviderId]=:id or other fields, according to the flow that you wish to implement.

Once you obtain the Transfer id, you can collect the information to process the payment with a custom workflow. you can make a PUT request to the resource to update the externalId and the status.

curl --request PUT \
--url \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{"externalId": "123123123","status": "completed"}'

Other available statuses can be found in the API Documentation.

πŸ”ƒ Returns β€” Previous
Setting a Return Label
Next β€” πŸ’² Payments
Custom Payment Settlements