Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Here’s the process to follow to build a provider implementation for a service

Review what is possible: First, review the services that can be implemented on OnePipe. Catalog of implementable services are here → Service Descriptions .

Understand the standard OnePipe payloads: See here

Understand the Provider APIs: First read through the provider’s API docs, digest and understand it.

Core service description: Now, identify the service you want to implement. Thoroughly read and understand it’s service description. If it doesn’t exist for the service you are thinking of implementing, contact Hussein Alayo or Victor Irechukwu to write it up. Don’t continue till this is done.

Understand and document the pricing: See to it that a section has been added to https://docs.google.com/spreadsheets/d/1UyAXwtarMBj0glpvT7wWuoIUpyIHCVy1ED7fdbUicRQ/edit#gid=249347743 for the provider and all pricing details filled for the service(s). Then set the API mappings column as well. Don’t continue till this is done.

Test Provider APIs: Create a collection of the provider’s APIs, test them against their test environment and get responses for every endpoint. Save this responses and create mocks. Save the final functional collection in the Provider APIs workspace on the OnePipe Postman account.

Create your own service description: Make a copy of the service description, name it {{provider}} {{service}}. Save as a child page of the service description. This should be based on your understanding of the service versus the provider’s internal APIs, ensure that your provider service description has the following components:

  • Settlement and fees model

  • Process flows and sequence of API calls

  • Any special notes.

  • List out what needs to be configured in provider override settings

See sample here.

Don’t continue till this is done.

Review the design: Review this design with at least 2 people. Discuss the settlement modalities with Victor Irechukwu and Yvonne-Faith Elaigwu to ensure it works out.

Write your code: Go ahead and build your provider

  • Write code

  • Test on dev (inspect)

  • Test on dev (live)

  • Promote and Test on staging

  • Promote and Test on production

  • No labels