Option 1: Customer Model 1 Overview

12011201

Option 1: Customer Model 1 Overview

API CallDescriptionRequired Previous Successful CallsRequired Input
Get Payment TypesTo 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 CurrenciesTo 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 CurrenciesTo 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

Get Quote for OrderTo provide a quote service for the order; a quote is returned following successful validation of the passed data.N/A

  • Order Header

  • GPFI Client Identifier

  • Foreign Order Id

  • Item Payment

  • Payer Custom Fields

  • Remitter

  • Remitting Bank

Log Previously Quoted OrderTo provide a service to log a previously quoted order.Get Quote for Order

  • GPFI Order Identifier

Get Payment InstructionsTo provide details of how to pay Convera for a logged item.Log Previously Quoted Order

  • GPFI Deal Reference

Get LanguagesTo provide a list of languages that the Payment Instructions PDF, and notifications, are available in.N/A
Get Order StatusTo provide details on latest status of the order.Log Previously Quoted Order

  • GPFI Client Identifier

  • GPFI Order Identifier

Get Disbursed Orders ReportTo provide details of settlement / disbursements from ‘Holding’ for the client at a disbursement level.Log Previously Quoted Order

  • Date Range

Get Disbursed ItemsTo 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 ReportTo 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 FormatTo provide a formatted address for consumption by the Incoming Payments API.N/A

  • Address