Option 3: Agent/Partner Model Overview

Option 2: Customer Model 2 Overview

API Call

Description

Required Previous Successful Calls

Required Input

Get Payment Types

To provide a list of payment types for the payer to choose from; the list is specific to the country where the payment will be received into a Convera bank account, and also to the client's ability to transact on
specific payment types.

N/A

  • GPFI Client Id
  • Remitter Country
  • Payment Currency

Get Payment Currencies

To provide a list of payment currencies for the payer to choose from; the list is specific to the country where the payment will be received into a Convera bank account, and also to the client’s ability to transact specific payment types.

N/A

  • GPFI Client Id
  • Remitter Country
  • Payment Currency

Get Settlement Currencies

To provide a list of settlement currencies for the payer to choose from; this list is associated to the currencies declared to be used by the client, and to be available in ‘Holding’.

N/A

  • GPFI Client Id

Log Order without Quote

To provide a validation and log service for order details that have been passed (i.e. there is no quote for these orders).

N/A

  • Order Header Item
  • GPFI Deal Reference
  • Payment
  • Payer
  • Custom Fields
  • Remitter
  • Remitting Bank

Edit Item in Logged Order

To provide a validation service for the amendment (of specific data) of a logged item.

Log Order without Quote

  • Order Header Item
  • GPFI Deal Reference
  • Payment
  • Payer
  • Custom Fields
  • Remitter
  • Remitting Bank

Cancel Logged Order

To provide a service to cancel a logged order prior to
funds being received.

Log Order without Quote

  • GPFI Order Identifier

Cancel Item

To provide a service to cancel a logged item prior to
funds being received.

Log Order without Quote

  • GPFI Deal Reference

Get Payment Instructions

To provide details of how to pay Convera for a logged item.

Log Previously Quoted Order

  • GPFI Deal Reference

Get Languages

To provide a list of languages that the Payment Instructions PDF, and notifications, are available in.

N/A

Get Order Status

To provide details on latest status of the order.

Log Previously Quoted Order

  • GPFI Client Identifier
  • GPFI Order Identifier

Get Disbursed Orders Report

To provide details of settlement / disbursements from ‘Holding’ for the client at a disbursement level.

Log Previously Quoted Order

  • Date Range

Get Disbursed Items

To provide details of settlement / disbursements from ‘Holding’ for the client at an item level.

Log Previously Quoted Order

  • GPFI Client Identifier
  • Date Range

Get Reconciliation Report

To provide details of items having been updated for settlement / disbursement from ‘Holding’ for the client.

Log Previously Quoted Order

  • GPFI Client Identifier
  • Date Range

Validate Address Format

To provide a formatted address for consumption by the Incoming Payments API.

N/A

  • Address

Did this page help you?