Versions Compared

Old Version 2

changes.mady.by.user João Reis

Saved on

compared with

New Version Current

changes.mady.by.user João Reis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Elavon Credentials

...

Method

Endpoint

Description

Example

POST

/boarding/v2/add_application

Add Application is the first of our V2 endpoints. This can be used to add a whole application in one call. A part application could also be added with the minimum data being Business Legal Name. The application reference will be in the response and should be used for all updates to this application. To collect any offering related data get_offer_packages, get_equipment_offer and get_acquiring_offer should be used. This API call can only be used in an integration only if Elavon’s E-Sign will not be used.

Code Block
{ 
  "merchant": { "reg_number": "111111111", 
  "reg_charity_number": "111111111", 
  "legal_name": "Vivax", 
  "ownership_entity_type": "L", 
  "current_ownership_since": "2020-08-13",
  ...

POST

/boarding/v2/update_merchant

Update merchant can be used to update any merchant level data using the application reference collected from the add application Request. This can be used in combination with V1 endpoints.

Code Block
{ 
  "merchant": { "reg_number": "111111111", 
  "reg_charity_number": "111111111", 
  "legal_name": "Vivax", 
  "ownership_entity_type": "L", 
  "current_ownership_since": "2020-08-13",
  ...

POST

/boarding/v2/update_outlet

Update outlet can be used to update any outlet level data using the application reference and Outlet Reference collected from the add application request. To collect the offering related data get_offer_packages, get_equipment_offer and get_acquiring_offer should be used. This can be used in combination with V1 endpoints.

Code Block
{ 
  "Application": { 
    "application_reference": "3301336" 
  }, 
  "outlet": { 
    "outlet_external_id": "XXX9C-6A40E-D0C25-94559-BE878-1C04F-1DFDC", 
    "trade_name": "dba name", 
    "store_number": "11111", 
    "outlet_website": "https://www.outletwebsite.com", 
    "business_email_address": "john.doe@elavon.co.uk",
    ...

POST

/boarding/v2/upload_document

Upload document can be used to upload any supporting documents for the application. References to be used, currently must be collected manually currently. This can be used in combination with V1 endpoints.

Code Block
{ 
  "application": { 
    "application_reference": "3301336"
  }, 
  "document": { 
    "document_reference": "REF1", 
    "upload_document_type_ref": "REF1", 
    "entity_id": "stringstringstringstring",
    ...

POST

/boarding/v2/submit_application

Submit Application is used to submit the application using an application reference, in the response the key “submit_success” is used to determine if the application passed the validation checks. If validation checks did not pass then the errors received will show in the errors array. This can be used in combination with V1 endpoints.

Code Block
{ 
  "application": { 
    "application_reference": "3301336", 
    "merchant_to_upload_document": "1" 
  } 
}

POST

/boarding/v2/retrieve_application

Retrieve application is used to retrieve all details associated with an application using the application reference. This can be used in combination with V1 endpoints.

Code Block
{ 
  "application": { 
    "application_reference": "3301336" 
  }
}

POST

/boarding/v2/unlock_application

Unlock application is used to unlock any application which has been locked after submission. This is only used for applications in a locked status such as awaiting signature and submission failed. This can be used in combination with V1 endpoints.

Code Block
{ 
  "application": { 
    "application_reference": "3301336" 
  }
}

POST

/boarding/v2/app_status_check

App status check is used to check the status of an application using the application reference number. This can be used in combination with V1 endpoints.

Code Block
{ 
  "application": { 
    "application_reference": "3301336", 
    "get_signer_details": "1", 
    "get_application_documents": "1" 
  } 
}

POST

/offering/v2/get_offer_packages

Get offer packages is used to determine which offer packages can be used. It shows the high level content of an offer package and will highlight the best available package. Once an offer package has been selected the transaction_pricing_ref and equipment_offering_ref can be used to collect the full details of the offers. To note, online offers are treated in the same way as an equipment offer.

Code Block
{ 
  "offer_packages": { 
    "mcc_iso": "7999B", 
    "average_transaction_amount": "10", 
    "annual_turnover": "100", 
    "country_code": "826", 
    "county_code": "hampshire", 
    "city": "Southampton" 
  } 
}

POST

/offering/v2/get_equipment_offer

Get equipment offer is used to retrieve the full details of the equipment or online offer. To retrieve the details the equipment_offering_ref must be first collected from the get_offer_packages call.

Code Block
{ 
  "equipment_offering": { 
    "equipment_offering_ref": "REF1" 
  } 
}

POST

/offering/v2/get_acquiring_offer

Get acquiring offer is used to retrieve the full details of the acquiring offer. To retrieve the details the transaction_pricing_ref must be first collected from the get_offer_packages call.

Code Block
{ 
  "transaction_pricing": { 
    "transaction_pricing_ref": "REF1" 
  } 
}